Manage the Partner API key

The Partner API key gives your integrations access to the Partner API. Your Partner has one Partner API key. You manage it in the API Key section of the Settings page.

Caution

The Partner Portal shows the full key only one time, immediately after you generate it. Copy the key before you close the box. If you lose the key, generate a new key.

The Partner API key is not the transfer-enabled API key

OneClick has a different key: the transfer-enabled API key. You make that key in the OneClick settings of a target company. It lets a user transfer a Button into that company. See Transfer a Button.

Key	Where you make it	What it does
Partner API key	The Settings page of the Partner Portal.	Gives your integrations access to the Partner API.
Transfer-enabled API key	The OneClick settings of the target company.	Allows a Button transfer into the target company.

A copy in the Partner Portal uses neither key. The Partner Portal does the copy for you.

Generate the Partner API key

1. In the sidebar, click Settings. The Settings page opens.
2. In the API Key section, click Generate API key. The window Generate API key opens.
3. Click Generate. The Partner Portal shows New API key generated. and the box New API key: copy now, you won’t see it again with the key.
4. Click the Copy icon. The Partner Portal shows API key copied to clipboard.
5. Put the key in the secret store of your integration.
6. Click the Dismiss icon. The box closes, and the section shows API key is set.

After a page reload, the section shows only the last 4 characters of the key. Use them to make sure that your integration has the correct key. A page reload also closes the box.

Rotate the Partner API key

When you rotate the key, you replace it with a new key. The old key stops working immediately.

1. In the sidebar, click Settings. The Settings page opens.
2. In the API Key section, click Generate new key. The window Generate new API key opens.
3. Click Generate. The Partner Portal shows New API key generated. and the box New API key: copy now, you won’t see it again with the new key.
4. Click the Copy icon. The Partner Portal shows API key copied to clipboard.
5. Put the new key in each integration that used the old key.
6. Click the Dismiss icon. The box closes.

Each integration that has the old key fails until it has the new key.

Revoke the Partner API key

When you revoke the key, no key works on the Partner API.

1. In the sidebar, click Settings. The Settings page opens.
2. In the API Key section, click Revoke. The window Revoke API key opens.
3. Click Revoke. The Partner Portal shows API key revoked.

The key stops working immediately. The section shows No API key set. You can generate a new key at any time.

Using the API

The box Using the API in the API Key section shows two URLs. Each URL has a copy icon.

• Base URL: the address of the Partner API, https://partners.theoneclick.io/api/v1.
• Documentation: the Swagger UI of the Partner API. It opens in a new tab.

Send the key in the token header of each request. See Partner API.

Related pages

• Partner API
• Settings fields
• Transfer a Button