This article explains what an API request is, how API usage is billed, and how to get access to the AMS+ API.
API (application programming interface) is a way for different applications to “talk” to one another. With our API, you can send client and lead information, notes, attachments, and more from third-party applications into AMS+, and retrieve records from AMS+. Also, our REST API is based on open standards, so you can use any web development language to access the API.
Pricing
Monthly: $75 (up to 10,000 requests/month), plus $50 for each additional 10,000 requests
- If your agency sends anywhere between 1-10,000 API requests throughout the month, your agency will be charged $75 for our API services during that month.
- If your agency does not send any API requests (0) throughout the month, your agency will not be charged for our API services during that month.
- Each additional block of up to 10,000 requests is billed as a full block, even if you send fewer than 10,000 requests in that block.
What counts as an API request
An API request is one message another application sends to AMS+ to ask it to do something, such as find a record, view a record, or add or change one. Each message goes to a specific web address called an endpoint, for example https://app.agencybloc.com/api/v1/individuals/create.
Each message counts as one request, no matter how much information comes back. For more details on setting up a request, see Making API Requests.
- Searching, viewing the full details of a record (called Detail in the API documentation), creating, updating, and deleting each count as one request.
- A search that returns many records is still one request. Viewing the full details of each record is a separate request for every record. For example, one search followed by a Detail request for each of 20 individuals is 21 requests.
- A request that AMS+ rejects still counts, whether the problem is with its data (such as a missing required field) or with its credentials (such as a wrong or missing API key).
- If the other application sends the same request again (called a retry), each attempt counts as a separate request.
- If your agency has more than one set of API credentials (an API SID and API key, described in Getting access), requests from all of them are added together.
- Requests are counted for each billing cycle. A billing cycle starts on your agency's billing day each month, so it may not match the calendar month.
You can see how many requests your agency has made in the current billing cycle if you are assigned to a Security Group (a set of permissions given to users) with the Manage Users or Manage Security Groups permission.
To see the count, select Profile & Settings > Subscription, and then check API Requests in the Features section. The page shows only the current billing cycle.
Getting access
If you or your developer are setting up an integration point (a connection between AMS+ and another application) with your AMS+ account, you'll need an API SID and API key.
- The API SID identifies your agency's API access.
- The API key is a secret code that gives full access to your AMS+ account, so protect it like a password and never email it.
The Account Owner can request these from the Support Team at 866-338-7075. For details on how to use these parameters (the values you send with each request), see Making API Requests.
Subresources
A subresource is a type of record you can work with through the API. AMS+ accounts have the following subresources. Select a link to read the API documentation for creating, searching, viewing, or updating each type of record.
Groups
Create, Search, Detail, Update
Individuals
Create, Search, Detail, Update
Leads (Sales Records)
Create Leads, Search Leads, Leads Detail, Update Leads
Policies
Create, Search, Detail, Update
Agents
Create, Search, Detail, Update