This article is for studio Owners and Admins who connect other tools to bsport. It covers creating, tracking and revoking API keys in Settings. For event notifications, see "Manage your webhooks".
For more information about bsport public API, please consult the dedicated documentation
Overview
An API key lets a tool you trust read and update your studio data through the bsport API. Reporting tools, custom integrations and automation platforms use keys to connect.
Manage keys from Settings > Webhooks & APIs, on the API tab. Each key belongs to your studio and is linked to a tool name, so you can see which tool uses which key.
Who can use it:
Condition | What you see |
Your role is Owner or Admin, and your bsport plan includes the Public API (Build, Engage or Elevate) | The API tab with your keys and the Create API key button. |
Your role is Owner or Admin, and your bsport plan doesn't include the Public API | The message "Upgrade your plan to use the API". Contact bsport to upgrade. |
Any other role | No API tab. The Webhooks tab stays available if your role has the Webhook permission. |
The Public API can also be added to a studio outside these plans. Contact bsport to ask.
What you can do
Create an API key for a tool.
Choose how long the key stays valid: 3 months, 6 months or 1 year.
See every key with its tool, expiry date, creation date, contact and status.
Revoke a key when you stop using a tool or suspect a leak.
Open the API documentation from the link at the top right of the page.
Common use cases
How to create an API key
Go to Settings > Webhooks & APIs and open the API tab.
Select Create API key.
Fill in the form:
Tool name (required): up to 24 characters, using lowercase letters, digits, hyphens or underscores, for example
reporting-tool. An active key can't share its tool name with another active key.Expires in: 3 months (default), 6 months or 1 year. The key stops working at the end of that period.
Contact email (optional): who bsport contacts about this key. Leave it empty to use the studio owner's email.
Select Create.
Read the warning in the form. A key gives full admin access to your studio, including client data and payments. Share it only with tools and people you trust.
How to save your key
After you select Create, the Save your API key window shows the key. This is the only time you see it.
Select Copy key and store it in a password manager. Don't share it by email or chat.
Select Copy headers to copy what your tool must send with each request.
Select Close.
If you close the window before copying, bsport asks you to confirm. If you close anyway, you can't see the key again: create a new key and revoke the first one.
How to connect your tool
Your tool sends two headers with every request to the bsport API:
Header | Value |
| The tool name you chose. |
| The key you copied. |
Endpoints and examples are in the API documentation.
How to revoke a key
On the API tab, find the key in the list.
Select Revoke key.
Confirm in the Revoke API key? window.
The tool stops working immediately and you can't undo this. The key stays in the list with the status Revoked and the revocation date. Its tool name becomes available again.
How to replace a key before it expires
Keys can't be edited or extended. To renew one:
Create a new key with a new tool name, for example
reporting-tool-2, or reuse the name once the old key is expired or revoked.Update your tool with the new key.
Revoke the old key.
How it works
Setup. An Owner or Admin creates the key and copies it once.
Activation. The key works as soon as it exists. Your tool sends the two headers with each request.
Normal use. The list shows each key's status.
After the action. Revoke a key to stop it right away, or let it expire.
Key statuses
Status | Meaning |
Active | The key works and expires in more than 30 days. |
Expires soon | The key works and expires within 30 days. Plan its replacement. |
Expired | The key reached its expiry date and no longer works. |
Revoked | You revoked the key. It no longer works. |
In the Contact column, You marks the keys that list your own email.
Important behaviors
One-time display. bsport doesn't store the key in a readable form. Nobody can show it again, including bsport.
Limit of 50 keys. A studio can hold 50 keys that aren't revoked. Expired keys count until you revoke them. At the limit, the page shows a warning and the create form can't be sent: revoke an expired key to create another.
Unique tool names. The name can't match an active key. Expired and revoked keys free their name.
Full access. A key isn't limited to one area of your studio. Create one key per tool, so you can revoke a single tool without affecting the others.
Plan changes. If your bsport plan no longer includes the Public API, the API tab shows the upgrade message and bsport refuses new keys.
Webhooks are separate. API keys don't create webhooks. See "Manage your webhooks".
FAQ
I lost my key. Can I see it again?
No. Create a new key, update your tool, and revoke the lost one.
Why is there no API tab for me?
The tab is for Owners and Admins only. Ask one of them to create the key.
Why do I see "Upgrade your plan to use the API"?
Your bsport plan doesn't include the Public API. It comes with Build, Engage and Elevate. Contact bsport to upgrade or add it.
Who is the contact email for?
It's the person bsport contacts about the key. If you leave it empty, bsport uses the studio owner's email.
Can I choose an expiry date?
The form offers 3 months, 6 months or 1 year.
Does revoking a key take time?
No. The tool is refused right away.