Overview

System Overview

The Alocity API is a REST API that lets you manage all the services and resources through simple HTTP requests. Our API has predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

On this site, you'll find the complete REST API documentation definitions of objects, guides, and some examples.

๐Ÿ“˜

The REST API endpoints in this documentation are the same ones being used to power our UI.

๐Ÿšง

Compatibility

Resources and endpoints not documented in this documentation should not be used as they are internal resources and can be changed or removed at any time, without any prior notice.

In order to start using our API endpoints, you must create your first access key. To manage your access keys, navigate to the Alocity portal and, once logged in, navigate to the settings page by clicking on the gear icon at the top of the page. Once on the settings page, click on the Integration card and you should now see the following page:

1670

Since this is the first time you will be accessing this page, you will not have any access keys and will need to create your first API key. The creation of your first API key is important, as it will create the API user that will be used to generate tokens for use in other endpoints in this documentation.

Once you've successfully created your first API key, the page will look something like this:

1661

By clicking the 'Reveal Key' button, you will be able to view your access key. Keep this safe, as this key will give anyone who has it the ability to create access tokens for your account. Visit the Authentication page for more information on how to use your access key.

If your access key is ever compromised, you can hit the 'Reissue Access Key' button to disable all active access keys and create a new one.

All access keys have an expiration of one year after they are created and, once expired, will no longer be usable. If your access key was used within 30 days of its expiration, a new key will be automatically generated to allow you time in switching access keys without having your services stopped abruptly due to an expired key. If you ever want to create a new key prior to your expiration, you can use the 'Reissue Access Key' button to give you a fresh access key, however, remember that it will also deactivate your other access keys.

Alocity API enforces a default rate limit of 100 requests per minute in order to achieve fair usage, controlled resource management and prevention of abuse. The default limit can be adjusted upon request to cover the specific needs of each API consumer.

On this page, you may have noticed that we also have a Webhooks tab. This page is explained in the Webhook Setup page filled with detailed explanations and pictures.