eBECAS/EDMISS Next Generation (Web)
eBECAS/EDMISS Next Generation (Web)
Breadcrumbs

API v2

The Equator API v2 provides secure, REST-based access to eBECAS/EDMISS, enabling organisations to integrate with third-party applications, automate business processes, and build AI-powered solutions.

Designed for modern development, API v2 includes token-based authentication, granular permissions, and comprehensive API documentation. It is well suited for workflow automation, AI agents, and custom integrations.

API v2 is the recommended version for all new integrations. Existing integrations can continue using API v1 where required.

Before you Begin

  • Ensure the Equator API App is installed and available in your system.

  • You must enable Multi-Factor Authentication (MFA) using an Authenticator App for your user profile. Organisation-wide MFA via email is not sufficient, as the app contains sensitive API credentials and configuration settings.

Next

  • API Authentication

    Each request is authenticated using an access token that is associated with an API User. This allows every request to be performed, authorised and audited as that user.

  • API Authorisation

    Authorisation controls what an API user is allowed to access and perform after they have been authenticated.

  • API Rate Limits

    The API implements rate limits to ensure the stability, performance, and fair use of the service.

  • API Usage Monitoring

    The API Usage page provides an overview of your organisation's API activity, helping you monitor request volumes and identify usage trends over time.

  • API Filtering, Sorting and Pagination

    Many API endpoints, such as search and reports endpoints, can return multiple records. These endpoints support request parameters that allow you to search, filter, sort, and paginate the results.

  • API Reference

    The API v2 Reference provides the technical specification for every API endpoint.

  • Utility Endpoints (Metadata)

    Utility endpoints provide access to metadata about the objects and fields available in the API. Rather than returning business data, such as students or enrolments, these endpoints return information that describes the structure of the API. This information helps you understand the available objects, their fields, and the values that can be used when building API requests.

  • API Best Practices

    Following these best practices will help you build integrations that are secure, reliable, and efficient.