Accessing the API
This step describes work necessary to obtain one of available authorization grants.
IP Allowlist
Depending on your companies setup you may want to add the Proximie endpoints to your whitelisted IP's.
There are 2 main endpoints required to be added.
| Endpoint Base URL | Description |
|---|---|
| https://auth.proximie.com | This is the main Base URL for all authorization requests to retieve Access Tokens. These tokens can then be used with the Proximie API. |
| https://my.proximie.net | The main production endpoint for the Proximie API. |
Obtaining your Organisation ID
A Organisation ID is a unique Identifier for your Organisation. This is a value issued by Proximie. It will be used throughout most of your calls to any Organisation flows. This key is also provided with the main Admin Access Credentials to your newly created Organisation.
Validating your Authorization
The /ping endpoint
/ping endpointWhen you have gone though your method of Authorization it may be worth testing your token should you have any issues with the main Proximie API. This endpoint will validate your token.
Should you have issues validating your token with the /ping endpoint, try fetching a new Access Token and retry.
The /server Endpoint
/server EndpointIf you are receiving errors non auth related when making requests to the /ping endpoint, it might be worth checking the /server endpoint. This endpoints returns the current Server Status and state of the Proximie Platform.
Updated almost 3 years ago