API Keys

Add API keys to use the TextPeak API.

In your SMS platform, you can add API keys to use the TextPeak API. The tokens generated for the created API keys can then be used by TextPeak API.

To access the API Keys page, expand Settingsin the main menu and click API Keys.​

Screenshot of the TextPeak side menu fragment with the 'Settings > API Keys' tab highlighted

API keys tab

Adding API Keys

From the Settings menu, you can add API keys to use the TextPeak API.

To add an API key:

  1. In the Settings section of the main menu, select the API Keys tab.
  2. Click the Add API Key button at the top right of the page.
Screenshot of the fragment of the 'API Keys' page and the 'Add API Key' button.

Adding new API keys

  1. Enter the new API key name in the pop-up window, select the IP ACL from the drop-down list, and click Add.
Screenshot of the dialog to add a new API key, which highlights the 'API Key Name' and 'IP ACL' input fields and the 'Add' button.

Add API Key dialog

  1. The key will be created, and the token will be generated for your new key. Click the Copy button to copy it to the clipboard.
Screenshot of the dialog showing a message to inform that the API key was created successfully  and displaying the key token with the 'Copy' button.

API key was created successfully dialog

  1. Click to close the pop-up window.

Managing API Keys

The created key will be added to the API keys table, where it can be managed, edited, or deleted. You can also click the eye button to see the API token for the selected API key record.

Screenshot showing the management options for the TextPeak **API keys** table, including 'Edit' and 'Delete' buttons. Also, the list of created API keys is displayed in the table with each record having the option 'Show API key contents'.

API keys table with management options

Select Edit to update the API key name and/or IP ACL. When done, click Submit.

Screenshot of the dialog to edit a TextPeak API key, highlighting the 'Name' and 'IP ACL' input fields and 'Submit' and 'Cancel' buttons.

Edit API key dialog

Click Delete to delete the API key and click Confirm.

Screenshot of the dialog showing a message to confirm the removal of the TextPeak API key and the 'Confirm' and 'Cancel' buttons.

Delete API Key confirmation dialog