Print this page
The Ringtail Connect API (application programming interface) allows you to programmatically retrieve data from 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, such as cases, users, and hosted data volume.
●Programmatically update Ringtail data in a Microsoft Excel spreadsheet.
●Query the API using HTTP GET and POST requests.
The Ringtail Connect API documentation includes the following sections:
●Concepts: Provides a basic overview of API terminology, and a detailed explanation of how to request data from 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, to programmatically retrieve and display Ringtail data in a Microsoft Excel spreadsheet, and to query the API using HTTP GET and POST requests.
●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 how to structure a request.