What is the Docs REST API?
The REST-based API has been introduced to support enhanced integration with the Docs application, and provides improved architecture over the previous SOAP API as the foundation for future API development. The REST API supports data calls for three main components of system data:
- Clearing Account
- Rate Schedules in Rate Schedule Library
- Reference Data (Parties & Products)
The API is designed to allow firms to access Docs data in their external systems, through either scheduled or ad hoc calls. While Docs includes functionality for Agreement detail export through the Agreement Search tool, the API provides access to a broader set of data points, providing a foundation for further internal reporting and data analysis.
Why should clients use the REST API?
1. For Agreement data, the API supports calls for agreement Details, or agreement Updates.
Details (p. 12 of documentation): Agreement ID, Clearing Accounts, Accounts, Bill To, Rate Schedule details, Parties, Dates, etc. These may be useful for clearing account reporting, particularly when paired with the Updates call, as well as pulling Rate Schedule information for schedules on agreements.
Updates: Returns agreements which have been updated within a specified timeframe
2. For Clearing Accounts, the API supports adding clearing accounts (single or multiple), and expiring accounts.
3. The Rate Schedule calls are designed for integration between third party rate schedule tools and the Docs Rate Schedule library. These API calls support the posting, deletion, and download of schedules from the library, noting that these DO NOT pull or post rate schedules to agreements themselves.
4. Reference Data calls provide details on agreement parties, as well as the various data points used in rate schedules (Exchanges, Product Groups, etc.) This data may be used in combination with details from the calls above to build out internal reports as well as integrate with additional systems, depending on a firm's needs and development resources.
In order to create and configure new API account, the following information must be provided by a Docs Admin of all parties for which the API account is permissioned:
- Admin approval for configuration
- Full list of parties for which the API should be Permissioned
- Unique Email Address to be associated with the API account. This email may not be used for another account in the system, and it may be helpful for firms to use a group email, to ensure profile access if individual users are unavailable.
- Tech Contact who should receive account details. Some firms may elect to have this consolidated and communicated through their Admin, however given the technical nature of API configuration, Admins may designate a tech contact to receive account credentials and details.