Authentication

Advantus API uses an authentication token to authenticate all the API requests. This token can be generated using a client_id and client_secret, which is unique for each application.

You can access and manage the client_id and client_secret from the Advantus Application.

To authenticate a request, include the access token in the Authorization header received from client_id and client_secret.

Standard Practices

Following are the standard practices to maintain the security and safety of your data:

Do not compromise your client_id and client_secret with anyone.
Reset the client_id and client_secret every six months for secure communication.

Method Type and API Endpoint

The Method Type and API Endpoint are as follows:

API Request

To send a request to the API, the following parameters must be included in the payload.

Parameter	Type	Description	Mandatory
client_id	string	The unique identifier assigned to your client application by Advantus, granting access to API functionalities.	Yes
client_secret	string	The confidential key is used, along with the user ID, to verify the identity of the application. It can only be accessed with the admin password.	Yes

  curl --location 'https://development-api.getnotifly.io/api/app/token' \
  --header 'eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo3NiwiZW1haWwiOzdWNoaXRyYUBwc3ljaHg4Ni5jb20iLCJzdGF0dXMiOjEsInJvbGUiOjAsImlhdCI6MTY4MzcxNjc1OCwibWZhIjpmYWxzZSwiZXhwIjoxNjgzNzU5OTU4LCJub3RpZmljYXRpb25fdmVydGljYWwiOjM4MzcsImNsaWVudF9pZCI6IjZjYTE5YmIwY2E5NjQwMDY4NzMwYTkzYWNmMTI4YjVkIiwiY2xpZW50X3NlY3JldCI6IkIzLURpM3plUXZ4dkVDVTRveFBBelEifQ.540PHZFN7ChHr7aA88auQ2ci6VrIBJTY_txGHq2: tezt' \
  --form 'client_id=YOUR_CLIENT_ID' \
  --form 'client_secret=YOUR_CLIENT_SECRET'

API Response

When making a request, replace your_client_id and your_client_secret with the client credentials. If the request is successful, you will get a JSON response containing the access token:

Success response use case

If the API receives a successful request, it will typically return specific parameters as part of the response:

  {
    "success": true,
    "message": false,
    "data": {
      "token": "YOUR_TOKEN_COMES_HERE_AS_RESPONSE"
    }
  }

Parameter	Type	Description	Mandatory
success	boolean	Indicating whether the request was successful or not.	Yes
message	boolean/string	Informs of additional value if sent along with the response, which can be either `false` or a `string` that defines the action done by the API caller.	Yes
data	object	A JSON object containing information related to the request	Yes
data.token	string	An authentication token allows to unlock API calls	Yes

Failure response use case

If the request fails, the API will return specific parameters (HTTP errors) as part of the response:

Error Code	HTTP Status	Cause	Solution
1025	400	`client_id` is missing	Provide `client_id` in API request
1026	400	`client_secret` is missing	Provide `client_secret` in API request
1033	400	Invalid `client_id` and `client_secret`	Provide a valid `client_id` and `client_secret` in API request

Overview