The Apiax APIs use JSON web tokens (JWT) to authenticate requests. You need to have a valid username and password to access the API and retrieve a JWT. Contact the Apiax support team to get your account.
Getting the Access Token
The following table describes the procedure to retrieve and use a JWT.
Method
POST
Endpoint |
https://auth.apiax.io/auth/realms/apiax/protocol/openid-connect/token |
This endpoint creates tokens valid for the production environment. |
Header |
Content-Type: application/x-www-form-urlencoded |
|
Request URL-Encoded Form Parameters |
|
The payload data are form parameters. Select the appropriate content-type for the request body to pass this data |
Response |
|
The response contains the access token at the JSON path You can use the access token as a bearer authentication header for subsequent API calls. Authentication: Bearer ACCESS_TOKEN The default expiration time for |
Retrieving a new Access Token with the Refresh Token
In the authentication response, the Refresh Token is included besides the Access Token (see Response structure above). This request token can be used to retrieve a new valid access token without sending the username and password again. The refresh token can be used 14 days starting after the retrieval of your Access Token with credentials.
Endpoint |
https://auth.apiax.io/auth/realms/apiax/protocol/openid-connect/token |
This endpoint creates tokens valid for the production environment. |
Method |
POST |
|
Header |
Content-Type: application/x-www-form-urlencoded |
|
Request URL-Encoded Form Parameters |
|
The payload data are form parameters. Select the appropriate content-type for the request body to pass this data |
Response |
|
The response contains the new access token at the JSON path You can use the access token as a bearer authentication header for subsequent API calls and the refresh token to get a new valid access token. Please note that the property Authentication: Bearer ACCESS_TOKEN |
Comments
0 comments
Article is closed for comments.