Configuring API Settings

Note: This article provides a basic overview. If you need help setting up this connection, we recommend reaching out to OmniByte or someone in your organization who has experience with technology or software development.

To allow trusted third-party systems to connect to forms, we use a secure method called OAuth 2.0. Specifically, it uses something known as the "client credentials flow" to keep your data safe. You can learn more about it here: https://auth0.com/docs/api-auth/grant/client-credentials.

1. From the Configuration menu, click API to open the API Configuration page.
   
2. Enter a REST Service URL which is the URL used to retrieve forms data. Click Copy to copy the URL to the clipboard for pasting into another source.
3. Enter an OAuth Server URL which is the URL used to retrieve security tokens for API calls. Click Copy to copy the URL to the clipboard for pasting into another source.
4. Enter a client ID and the shared secret which are used to authorize calls to the API. Click Copy to copy the client ID or shared secret to the clipboard for pasting into another source.
5. Click Regenerate when you get a new client ID and/or shared secret. This removes access to old connections and updates to new.
6. Click Save to save the configuration information.