Overview
You can manage your API credentials on the Preferences tab under Credentials. On this tab you can add, remove, edit, enable, and disable credentials. Only Admin level users have access to the credentials management screen.
Pro Tips
Always create a new set of credentials for each new use case or integration.
If you create one set of credentials and use it for multiple integrations (e.g. CargoChief, Turvo TMS, etc.), you will run into issues later if you stop using any one of the integrations and need to disable data access. You will have to either continue allowing data access to the removed integration partner or create new credentials for all your other partners. Creating a new set of credentials for each integration lets you easily edit, disable, or delete one partner’s credentials without affecting any other integration. It also means that if a set of credentials is compromised, you can delete them quickly and protect your data.
Write a short but easily understandable description for each new set of credentials. Otherwise you won't be able to identify them.
For instance, if you’re creating credentials to configure the greenscreens.ai integration in Turvo TMS, we recommend entering something like "Turvo TMS integration" in the Description field. This lets you keep track of which credentials belong to which integration, which is very important if you need to disable or otherwise manage access for an integration partner. It also allows us to quickly identify the proper credentials when debugging any issues you may encounter with the integration.
The Credentials Management Tab
Accessing the Credentials Management Tab
Click your Profile icon on the upper right of your screen:
In the dropdown menu, select Preferences:
Click Credentials (Remember, if you’re not an Admin user, you won’t be able to see the Credentials tab):
Navigating the Credentials Management Tab
API Details
The API URL: https://api.greenscreens.ai. This is the API URL that you will need to make calls to our API:
Our API documentation, including endpoints and their definitions, is also linked on the Credentials tab:
The Credentials Table
This is where your credentials are displayed. Remember to create a new set of credentials for each integration.
The Status column shows the enabled or disabled status of the credentials. Disabled credentials cannot be used to gain access to the API:
The Client ID column displays an automatically generated unique ID that you will need to authenticate the API. You will need to be able to differentiate between these, so entering a clear description for each set of credentials is important. You can quickly copy a Client ID by clicking the Copy icon to the right:
The Client Secret column contains the client secret for a set of credentials. The client secret is automatically generated. It’s similar to a password, and you’ll need it when authenticating in the API. You can view or copy the client secret by clicking the corresponding eye or copy icon:
The Description column contains your description of the credentials set. Because the Client ID is automatically generated, using a clear description is very important here:
Adding credentials
To add a new set of credentials:
Click Add Credentials:
Enter a description for the new credentials. It is important to use a clear description for each set (e.g. “Turvo TMS integration”), so that you can find the credentials later, and so we can find them if you encounter integration issues that need debugging.
Click Add to add your new set of credentials:
Managing Credentials
The three-dot menu on the right allows you to enable, disable, edit, and remove credentials, or regenerate a client secret.
Editing Credentials
To edit the description of your credentials:
Click the three-dot menu and select Edit:
Make your changes to the description and click Save:
Disabling Credentials
Disabled credentials cannot be used to access the API. To disable credentials:
Click the corresponding three-dot menu and select Disable:
Click Disable to confirm:
Enabling Credentials
Only enabled credentials can be used to access the API. New credentials are enabled by default. This action is only available for disabled sets of credentials. To create a new set of credentials, see Adding Credentials.
To enable credentials:
Click the corresponding three-dot menu and select Enable:
Click Enable to confirm:
Removing Credentials
You may need to remove credentials that have been compromised or that are no longer used. Removed credentials cannot be used to access the API. To remove credentials:
Click the corresponding three-dot menu and select Remove:
Click Remove to confirm:
Generating a New Client Secret
The client secret is something like a password. It’s required to authenticate a client application. You may need to generate a new client secret if a set of credentials is compromised and you don’t want to delete and recreate them. When you generate a new client secret, anyone who uses that set of credentials will need the updated secret to gain access to the API.
To generate a new client secret:
Click the corresponding three-dot menu and select Regenerate Secret:
Click Regenerate to generate a new client secret:
