This page gives an overview of what is needed to begin work on integrating with the Arken Public API.
Please also see the following pages for more details.
Introduction
Arken provides a HTTP based REST API which allows clients to retrieve or manipulate information in the Arken system. To get started using the Arken API all you need is:
- Create an Arken account
- Request authentication from Arken
- Start coding and call the API endpoints
Information
To begin using the Arken API all you need is:
- Base URL
- Authentication
- Endpoints definition (HTTP Method, URL Path, response format)
Base URL
- See the API Endpoint documentation for the relevant environment base URL
These are for the Arken API test environment. Once your integration and testing are complete we will give you a base URL for the live environment as well as a new personal client ID and client secret.
Authentication
The Arken API uses a JSON Web Token (JWT) to securely transmit information between parties.
To generate the JWT you will need to request access. Arken will supply you with a personal client ID, client secret, audience and the request URL needed to generate a JWT token.
The token must be sent as a HTTP request header using the Bearer schema, with each API call:
| Authorization: Bearer <token> |
|---|
The token is valid for a 24 hour period.
API Endpoints
See the API Endpoints section