Equator API App
The Equator API app provides programmatic access to the system data and functionality, allowing colleges to create custom integrations with eBECAS/EDMISS.
The Equator API is a paid app. Contact us for pricing details.
Configuration
Before using the Equator API app, ensure you have an active API user account. If you don't have it, please create one before proceeding.
Multi-Factor Authentication must be enabled for users accessing the Equator API Configuration.
Follow these steps to set up the app.
From the Utilities menu, go to Apps, then click on the View button on the Equator API app. If you do not see the app listed, contact your system administrator.
Click on the Configuration button on the Equator API details page.
Choose the API user that will perform the actions from the API.
Click on Update.
View API Usage
The Equator API App provides a clear overview of your API activity, showing usage from the past 24 hours as well as daily totals from the last 5 days. This allows you to quickly monitor and track recent API consumption.
From the Utilities menu, go to Apps, then click on the View button on the Equator API app. If you do not see the app listed, contact your system administrator.
Your API usage for today and the last 5 days will display in API Usage section.
API Requests, Responses and Limits
Pagination
API endpoints that return multiple records use pagination to control the response size. When using these endpoints, you must implement a loop to fetch all pages.
By default, PageSize (the number of records per page) is set to 100. You can override this value by including the PageSize parameter in your request, up to a maximum of 1,000. If you request more than the allowed limit, the API will return HTTP status code 400 “Bad Request”.
To request a specific page, use the PageCount parameter to indicate the page number you want to retrieve.
Each response includes the following pagination fields:
PageSize (integer, required): Number of records returned per page.
PageCount (integer, required): Total number of pages.
RecordsCount (integer, required): Total number of records matching the request.
Note: The field name may vary depending on the endpoint. Refer to the API documentation for details.
To retrieve all records, perform multiple requests, incrementing the page number until all pages are processed. Keep the PageSize consistent across requests to avoid missing or duplicating records.
The total number of pages can be calculated as follows:
ceil(RecordsCount / PageSize)Limits
There are limits to the number of API calls that your application can make,
Daily Rate Limit
API usage is subject to daily rate limits, applied per customer. Each customer is allocated 10,000 API calls per 24-hour period as a baseline, plus an additional 1,000 calls per active user license under their subscription. These limits apply only to API calls made through your own applications and do not include usage from integrations provided directly by Equator IT. Separate limits may apply to those integrations.
If your application exceeds the allocated limit, we may throttle or temporarily suspend access until usage returns within acceptable levels. We will notify you if sustained high usage requires a review or adjustment of your rate limits. Please contact us if you require increased capacity.
Exceeding a Limit
Exceeding a rate limit will result in an HTTP 429 (too many requests) response.
Exceeding the Page Size limit will result in a HTTP 400 (bad request) response.