Skip to main content
Version: V2

Authentication

The authentication API is used to obtain valid tokens starting from a valid API key.

API Key Management​

Each API key consists of two components: secret and clientId. The platform administrator manages API keys and has the ability to create, modify, and delete them, as well as define access permissions associated with each key.

If a user has read-only permissions, any services requiring edit permissions will be inaccessible. For example, any HTTP call using verbs other than GET will receive a 403 Forbidden response.

Use Case Diagram​

Below is a use case diagram illustrating the typical roles and responsibilities of the system administrator and client:

Bearer Token Generation​

Apparound provides a dedicated service for generating a Bearer Token. Generated tokens have a limited lifespan to enhance security. Once you receive the two components, secret and clientId, from the system administrator, you can invoke all authenticated Apparound API Services by inserting the Bearer Token into the Authorization header.

Sample REST Calls to Authentication Service​

curl --location 'https://api.apparound.com/apikey/token' \
--header 'Content-Type: application/json' \
--data '{"clientId": "XXXX", "secret":"XXXX"}'