Create and manage API keys
Your server uses API credentials to call the Shows API. Each credential belongs to one project and one environment.
- Sandbox: for testing. Sandbox keys never create real orders or payments.
- Live: creates real orders and payments.
Create a credential
- Open the project and go to the API credentials tab.
- Select Create credential.
- Enter a Name (up to 60 characters), for example "Checkout server".
- Choose the Environment.
- Choose when it Expires: 30 days, 90 days, 1 year or a Custom date.
- Select Create credential.
Save the secret
The API secret is shown once. Select Copy secret, store it somewhere secure, then tick I have saved this somewhere secure.
Keep the secret on your server. Never put it in public web pages or mobile apps. If you lose it, it can't be recovered: rotate the key to get a new one.
Rotate, rename or revoke
Open the credential to see its status, when it expires, when it was Last used and who created it.
- Rotate credential: creates a new key and immediately revokes the old one. Update your integration with the new key straight away.
- Rename credential: changes the name shown in the portal.
- Revoke credential: blocks new requests with this key. Revoking a live key stops it working immediately and can't be undone. Existing orders and payment obligations remain.
If a team member who copied a secret leaves, the project may show a credential review. Rotate any key that person may have kept.
Was this article helpful?
