API Request Resources
Security
Security for the API is handled by two parameters that need to be used on every call and be posted via the body. For information on how to obtain these parameters, visit this article.
| Parameter | Description |
|---|---|
| sid | This value will be provided to you by AMS+ for consuming the API. |
| key | This value will be provided to you by AMS+ for consuming the API. |
API Key Security
API keys grant full access to your AMS+ account, so you should protect them the same way you protect your AMS+ account password. Never email the API key; in the event that your email account becomes compromised, the emailed key would allow hackers to access your AMS+ account as well.
Base URL
All URLs referenced in the documentation have the following base:
https://app.agencybloc.com/api/v1/
The REST API is served only over HTTPS. This ensures data privacy by encrypting all traffic to and from the API. HTTP is not allowed to ensure data protection.
API Request Format
Our REST API is based on open standards, so you can use any web development language to access the API.
To make a request, you'll make an HTTPS POST to the applicable endpoint URL.
For example: https://app.agencybloc.com/api/v1/individuals/create
No parameters should be in the URL or querystring. The body of the request must contain the security credentials, as well as the method-specific parameters.
For example:
- sid=mySID
- key=myKey
- lastName=Doe
- firstName=John
And the Request Content-Type must be application/x-www-form-urlencoded.
For example:
POST /i HTTP/1.1 Host: https://app.agencybloc.com/api/v1/individuals/create Cache-Control: no-cache Content-Type: application/x-www-form-urlencoded sid=mySID&key=myKey&lastName=Doe&firstName=John
Note: The responses from the API are in JSON format as described in the method descriptions, but you do not POST JSON-formatted requests. They must be in application/x-www-form-urlencoded format per the above.
Rate Limits
The API is rate limited. You may access the API up to 2,000 times per 5-minute period. If the rate limit is exceeded, the API responds with a 403 HTTP response.