Print this page
In this topic
By default, all users are denied access to the Ringtail Connect API. System administrators can authorize users to access the Ringtail Connect API.
The Ringtail Connect API respects the same security settings as the Ringtail application. If you allow a user to access a certain type of data through the Ringtail interface, the user is allowed to access the same data through the API. For portal administrators, when organizations security is enabled, the data that can be accessed depends on portal administrator membership, if any, in provider or client organizations. For more information about organizations security, see the Portal Administrator Help.
Use the following procedure to allow users to access the Ringtail Connect API.
1.On the Portal Home page, under Portal Management, click User Administration.
2.On the Users page, click a name.
3.In the navigation pane, click API Access.
4.Select the Authorize this user to use the Ringtail Connect API check box.
Ringtail generates an API token and an API key for the user.
To allow users to access Ringtail data from outside of Ringtail using the Ringtail Connect API, a system administrator must provide each user with a unique API token and API key. The token and key authenticate the user.
A user must include their token and key when they use the API to request data from outside of the Ringtail application. For example, a user must provide their token and key when they populate tables in Microsoft Excel with Ringtail data.
Users do not need to know their token or key to access Ringtail data using the Ringtail Connect API Explorer.
Use the following procedure to obtain a user's API token and key.
1.On the Portal Home page, under Portal Management, click User Administration.
2.On the Users page, click a name.
3.In the navigation pane, click API Access.
4.Do the following:
oTo copy the token, click Copy API token. The token is copied to the clipboard. Paste the token in a text editor.
oTo copy the key, click Copy API key. The key is copied to the clipboard. Paste the token in a text editor.
5.Provide the token and key to the user.
Caution: Users should store their API token and key in a secure location, the same way that they protect their password. Anyone who has a user’s token and key can access all of the data that the user can access through the API.
You can revoke a user's access to the Ringtail Connect API.
If you believe that a user's API token or key has been compromised, you should revoke the user's access to the Ringtail Connect API. This revokes the API token and key. You can then reauthorize the user, and provide them with a new token and key.
Use the following procedure to deny users access to the Ringtail Connect API.
1.On the Portal Home page, under Portal Management, click User Administration.
2.On the Users page, click a name.
3.In the navigation pane, click API Access.
4.Clear the Authorize this user to use the Ringtail Connect API check box.
The API token and key are revoked, and the user is no longer able to access the Ringtail Connect API.
Note: If you grant the user access to the API in the future, you must provide them with a new API token and key.
