APIs
As part of our platform's structured evolution, we have categorized our application programming interfaces (APIs) into three distinct classifications. Our initial framework was anchored by the Legacy API - a comprehensive set serving both user and administrative roles. Recognizing the need for specialized and distinct service offerings, we introduced the User and Admin APIs. The User API is crafted to encompass all functions necessary for clients to successfully capture themselves. Conversely, the Admin API incorporates functionalities from the User API and additionally integrates features specifically designed for comprehensive service administration. The following table offers a clear overview of these API classifications and their respective roles:
API | Scope | Description |
---|---|---|
Legacy | User + Admin | Includes all endpoints for both users and administrators. Deprecated in 13.3, removal scheduled for 15.0. |
User | User | Encompasses all functions necessary for clients to interact with the system. |
Admin | User + Admin | Combines all User API endpoints, plus additional endpoints for service administration. |