Requirements
The Aiphoria API is very flexible but you do need an API key, an Environment Sub Domain and something to provide you back analysis with. All the information is provided below:
API Key
The API key will be provided to you upon account creation. This is a long lived JWT and is used to request a short lived JWT. The Account API key cant be used for API requests (other than auth) and the short lived JWT should only be refreshed once it has expired or is about to expire.
Currently short lived JWTs are valid for 24 hours however this may change so please ensure you application checks the expiry date or is able to request a new JWT if the Aiphoria API response with a 403 (Forbidden).
The short lived JWT (referred to from now on as a Token) contains the following payload information when decrypted:
{
"id": 2,
"role": "client", //Shows the type of token
"clientId": 25,
"apiKey": "YOUR API KEY",
"iat": 1710868068, //The date and time the token was requested
"exp": 1710958068 //The date and time the token expires
}
If you wish to verify the signature, the secret is base64 encoded
See Authentication for full usages information
Environment sub domain
Aiphoria provide a Sandbox (testing area) and a production environment for all customers. All API requests require a full base URL, within this documentation you will see references to subdomain. This needs to swapped out to the environment you wish to target. To enable simple development and testing the rest of the process and API requests are identical between all environments.
The sub domains currently available are:
| Sub domain | Description |
|---|---|
| sandbox | This is the Aiphoria testing and integration playground. Note that the servers in this zone are scaled down and should not be used for production traffic. They are available 24/7 and post go live for you to continue to test any updates or changes but carry no SLA. |
| uk | This is a production URL that will keep traffic and processing within the UK. |
| de | This is a production URL that will keep traffic and processing within the Germany. |
| other... | Have a requirement for data or processing in another region, let our support team know and we can start an instance in that location. |
Due to the Aiphoria geo resilient setup the underlying ip addresses used by the domains may change. As a result, if you do use a whitelist, you must whitelist the FQDN and not just the current IP address for the FQDN. To use a region specific URL they must be enabled on your account, please contact support if you require more than one production region.