The first step to making calls using the API is to provide the correct authentication details. If you have not already been set up with an account, ask that the owner of your account invite you as an API admin. Once invited, you are able to log in the back end of the system, navigate to admin management (under the settings tab), click on your admin account, and collect your details. If you have any trouble collecting these details, please contact email@example.com and they will be able to assist you.
In the image below:
- Api-user is firstname.lastname@example.org, the email associated with the account
- Api-token is cd8c417d-7cde-4bbe-83fc-94fccd7c0379
- Api-id is 23218, in the top right
In each request to the API, you must authenticate yourself by including four components in the header of your request:
This is the login email associated with your admin account.
This is the authentication token which you can find in the profile tab of your API admin (in the admin management page).
This is the id associated with your admin account.
The time stamp is an additional layer of security. Make sure that you are updating the timestamp to the current time if your are iterating through calls!
Using cURL, the basic authentication would look like: