Generating an API Key

Generating an API Key

In order to utilize the API, you need an active Agility Blue user account (this is your "Authorization") and a valid Agility Blue API Key (this is your "Authentication"). Every request made to the API needs a valid Api Key, or you will probably get a 401 Unauthorized response. The only exception to this is the versions endpoint (https://api.agilityblue.com/versions). You can check this endpoint using your browser or a GET call without any authentication to receive a list of name-key value pairs containing versions to the various platform builds. This information may be useful to check from time to time as some resources may not be available in earlier versions of the API.

Once you have a valid user account, you can go to your account page within the main application and click on the developer tab. From there, you can generate new API keys or revoke keys you are no longer using. API Keys run in the same context as the user they are generated for, so be careful with how you store or expose them!

More information about the API can be found on the reference site.