Print this page
In this topic
You can query the Ringtail Connect API using HTTP GET and POST requests. This allows you to build custom applications that request data directly from Ringtail.
The Ringtail Connect API connects using HTTP and consumes data in JSON format.
A GraphQL operation returns data as a JSON object. The structure of a response mirrors the structure of an operation.
Tip: You can create and test queries in the API explorer before running queries in a third-party application. For more information about the API explorer, see Access and use the Ringtail Connect API Explorer.
Before you start, do the following:
●Obtain your Ringtail API token and API key from your system administrator. Your token and key authenticate you. For more information, see Obtain an API token and key for a user.
Caution: Store your API token and key in a secure location, the same way that you protect your password. Anyone who has your token and key can access all of the data that you can access through the API.
●Obtain the URL of the API service for the portal from your system administrator. The URL of the API service is available in the Portal Management area, in the Settings section, on the Portal Options page. For more information, see Ringtail Connect API URL.
HTTP method: GET
Resource URL: URL of the API service for the portal, such as http://ringtail.com/Ringtail-Svc-Portal/api/query. For more information, see Before you start.
HTTP headers:
Header |
Required? |
Authorization: bearer yourAPIToken |
Required |
ApiKey: yourAPIKey |
Required |
Parameters:
Parameter |
Required? |
Description |
query |
Required |
The query to run. Encode the query as valid ASCII format, so that it can be passed as part of a URL. |
variables |
Optional |
The variables in the query. Encode the variables as valid ASCII format, so that it can be passed as part of a URL. |
Request body: Not applicable.
HTTP method: POST
Resource URL: URL of the API service for the portal, such as http://ringtail.com/Ringtail-Svc-Portal/api/query. For more information, see Before you start.
HTTP headers:
Header |
Required? |
Content-Type: application/json |
Required |
Authorization: bearer yourAPIToken |
Required |
ApiKey: yourAPIKey |
Required |
Parameters: Not applicable.
Request body:
Parameter |
Required? |
Description |
query |
Required |
The query to run, formatted as valid JSON syntax. |
variables |
Optional |
The variables in the query, formatted as valid JSON syntax. |
