This guide will show you how to create, manage, and update your Partner API Key within the Peaka platform.

When your partnership with Peaka is active, the Developer section will appear in the sidebar on the homepage.

open developer page

Creating a Partner API Key

  1. Navigate to the Developer section.
  2. Click on the Partner API Key button to open a dialog box.
  3. Fill in the form by entering your desired API Key Name.
  4. Click on the Create button.
create partner api key dialog

Your Partner API Key will be displayed in the dialog box, where you can copy and use it.

created partner api key dialog

Updating Status

By default, when a Partner API Key is created, its status is set to active. If you wish to deactivate the key, toggle the switch to the off position.

update status of partner api key

Editing a Partner API Key

  1. Click on the three dots icon of Partner API Key which you want to edit.
partner api key menu
  1. Select the Edit Name button, which will open a dialog box.
  2. Enter the new API Key Name and click on the Update button.
edit partner api key dialog

Your API Key name will be updated accordingly.

edited partner api key

Deleting a Partner API Key

  1. Click on the three dots icon of Partner API Key which you want to delete.
partner api key menu
  1. Click the Delete button.
delete partner api key dialog

Your Partner API Key will be deleted.

deleted partner api key