- This line was added.
- This line was removed.
- Formatting was changed.
|The REST-based administration web service makes it possible to configure parts of Digital Access component without using the graphical user interface. This is very useful if parts of the configuration needs to be done automated or when using Nexus PRIME as main frontend.|
You find a list of all supported configuration items, as well as a detailed documentation of the endpoints, within the Digital Access component appliance itself.
Use the URL https://<hag admin service dns name>:8443/swagger to find the documentation, as well as an editor to test the interface directly.
When integrating the web service endpoints in your client, you need to authorize your client first. This is done using OAuth 2.0 that is integrated in Digital Access component itself. To learn more about Digital Access component and OAuth 2.0, read the following article: Configure OAuth 2.0 in Digital Access
This article describes how to enable OAuth 2.0 authorization for the administration web service.
In order to use the web service you need to specify an OAuth 2.0 client that can authorize against the service.
In order to use the web service you need to specify a web resource that can authorize against the service.
To connect to the web service, use a web service client tool of your choice. Before accessing the web service endpoints, request an access token with grant type Client Credentials from the access token URL https://<hag access <access point dns name>/https/api/rest/v3.0/oauth/token.
You can now use the API using https://<admin service dns name>:<admin service port>/rest/v2, for example: passing the HTTP header as Authorization: Bearer <token>.