Self-Service API Key Management

With the self-service feature for creating API keys, you can generate API keys for accessing multiple API sets independently, without help from the Gotransverse team. API keys can be used to access the GTV API sets that include Billing, Dunning, Revenue Management, Configure Price Quote, Currex, Job Scheduler, Stored Value Service, Tax Essentials, and Usage Processing.

To generate API keys, you must either have an Admin role or a newly created role with the Manage User API Keys authority included in it along with access to the User Management page.

The Api Keys pane on the User Management page displays all API keys available for the current user. Newly created API keys can be viewed, edited or deleted. IDs of API keys previously created by the GTV team are also listed in User Management, but these keys cannot be edited or deleted.

Note: For information about using API keys, refer to Authentication and the Header.

Generating a New API Key

To generate a new API key:

  1. Navigate to the User Management page by doing one of the following:
    • In the Gotransverse Navigation Bar, navigate to Admin > Users, then select the current authorized user.
    • Click your user name in the upper-right corner of the page.
  2. Next to Api Keys, click Generate key.

    Note: If you don’t see the Generate key button, the user doesn’t have the right permissions.

  3. In the New Api Key window, enter the following:
    FieldDescription
    NameRequired. The name of the API Key.
    DescriptionAdditional information about the API Key.
    Available Api/ Selected Api

    Required. Select API sets to be accessible through the API key.

    • To select API sets, click items in the Available Api column and click the right arrow to move them to the Selected Api column.
    • To remove Available Api options, click items in the Selected Api column and click the left arrow to move them back to the Available Api column.

  4. Click Finish to complete generating the API key. Alternatively, click Cancel to discard your changes.
  5. In the Save generated key window that displays the API key, select the necessary option.

    Note: Once you generate the API key, it will not display in the UI.

    • Copy to clipboard—Select to copy the generated API key to your clipboard.
    • Download—Select to download the .apikey file containing the generated API key. To open it, use any text editor such as Notepad++.
    • Close—Select to close the Save generated key window.

Editing an API Key

You can edit the information about the API key and modify the number of API sets to which access is granted. To edit the API key:

  1. Navigate to the User Management page by doing one of the following:
    • In the Gotransverse Navigation Bar, navigate to Admin > Users, then select the current authorized user.
    • Click your user name in the upper-right corner of the page.
  2. In the Api Keys pane, click Edit next to the necessary API key.
  3. In the Edit Api Key window, modify the necessary fields that may include: Name, Description, Available API Sets.

  4. Click Finish to save your changes. Alternatively, click Cancel to discard the edits.

Deleting an API Key

To delete the API Key:

  1. Navigate to the User Management page by doing one of the following:
    • In the Gotransverse Navigation Bar, navigate to Admin > Users, then select the current authorized user.
    • Click your user name in the upper-right corner of the page.
  2. In the Api Keys pane, click Delete next to the necessary key.
  3. In the Confirmation window, click Yes to delete the API key.