When working with Basiq APIs your application will need to complete the authentication process first before you can access any of the available resources.
The process requires you to exchange your API key for a token. Once you obtain the token, you can call any of the available API services by simply including the token in the Authorization header of each request.
Note: Your token will expire after 60 minutes, so ensure you are caching the token and only generating a new one when necessary. Excessive use of the
/token endpoint may result in unsuccessful requests.
Your API keys carry many privileges, so be sure to keep them secret!
Do not share your API keys in publicly accessible areas such GitHub, client-side code, etc.
Prior to authenticating your application you will need to complete the following steps:
- Sign-up to the Basiq API service
- Grab your API key for your application (via the Developer Dashboard)
Token scope: CLIENT_ACCESS or SERVER_ACCESS
The scope of a
CLIENT_ACCESStoken is restricted and should be used for all client side requests for security reasons.
CLIENT_ACCESStoken only grants access to the following requests:
- Access the Consent UI (Note: for this request you will need to bind your
userIdto the access token the same way you do the scope)
- Check job status
SERVER_ACCESStokens can be used for all endpoints and has full access to create resources and retrieve data. They should never be exposed on the client side.