Print this page
The Ringtail Connect API (application programming interface) allows you to programmatically retrieve data from Ringtail and write data to Ringtail.
For example, with the Ringtail Connect API you can access data that can be used to build client invoices. You can request data about hosted volume by case, production counts, and other relevant data, and then use that data to create custom invoices for your clients.
You can perform the following tasks using the Ringtail Connect API:
●Request data about a portal or case, such as users, documents, and hosted data volume.
●Modify data in a Ringtail portal or case.
●Programmatically use Ringtail data in an external application, such as a Microsoft Excel spreadsheet.
●Interact with the API using HTTP GET and POST requests.
The Ringtail Connect API documentation includes the following sections:
●API terminology: Provides a basic overview of API terminology used in the Ringtail Connect API.
●Introduction to making API calls: Provides a detailed explanation of how to retrieve and modify data in Ringtail.
●Use the Ringtail Connect API: Explains how to configure security for the Ringtail Connect API, to work with the API in an interactive API explorer, and to interact with the API using third-party applications. Includes an example of how to programmatically retrieve and display Ringtail data in a Microsoft Excel spreadsheet.
●Reporting examples: Provides sample queries that you can use as a starting point to create queries for common reporting tasks.
●Reference documentation: Explains how to access comprehensive information about the schema. The schema determines what data you can request and modify, and how to structure an API call.