Dit artikel is voor studio-Owners en Admins die andere tools koppelen aan bsport. Het behandelt het aanmaken, bijhouden en intrekken van API-sleutels in Instellingen. Voor gebeurtenismeldingen, zie "Je webhooks beheren".
Voor meer informatie over de publieke bsport-API raadpleeg je de speciale documentatie
Overzicht
Met een API-sleutel kan een tool die je vertrouwt je studiogegevens lezen en bijwerken via de bsport API. Rapportagetools, aangepaste integraties en automatiseringsplatforms gebruiken sleutels om verbinding te maken.
Beheer sleutels via Instellingen > Webhooks & API's, op het tabblad API. Elke sleutel hoort bij je studio en is gekoppeld aan een toolnaam, zodat je kunt zien welke tool welke sleutel gebruikt.
Wie het kan gebruiken:
Voorwaarde | Wat je ziet |
Je rol is Owner of Admin, en je bsport-abonnement omvat de publieke API (Build, Engage of Elevate) | Het tabblad API met je sleutels en de knop API-sleutel aanmaken. |
Je rol is Owner of Admin, en je bsport-abonnement omvat de publieke API niet | Het bericht "Upgrade je abonnement om de API te gebruiken". Neem contact op met bsport om te upgraden. |
Elke andere rol | Geen tabblad API. Het tabblad Webhooks blijft beschikbaar als je rol de rechten voor webhooks heeft. |
De publieke API kan ook worden toegevoegd aan een studio buiten deze abonnementen. Neem contact op met bsport om dit te vragen.
Wat je kunt doen
Een API-sleutel aanmaken voor een tool.
Kiezen hoe lang de sleutel geldig blijft: 3 maanden, 6 maanden of 1 jaar.
Elke sleutel bekijken met de bijbehorende tool, vervaldatum, aanmaakdatum, contactpersoon en status.
Een sleutel intrekken wanneer je stopt met het gebruik van een tool of een lek vermoedt.
De API-documentatie openen via de link rechtsboven op de pagina.
Veelvoorkomende toepassingen
Een API-sleutel aanmaken
Ga naar Instellingen > Webhooks & API's en open het tabblad API.
Selecteer API-sleutel aanmaken.
Vul het formulier in:
Toolnaam (verplicht): maximaal 24 tekens, met kleine letters, cijfers, koppeltekens of underscores, bijvoorbeeld
reporting-tool. Een actieve sleutel kan geen toolnaam delen met een andere actieve sleutel.Verloopt over: 3 maanden (standaard), 6 maanden of 1 jaar. De sleutel werkt niet meer na afloop van die periode.
Contact-e-mailadres (optioneel): wie bsport contacteert over deze sleutel. Laat dit veld leeg om het e-mailadres van de studio-eigenaar te gebruiken.
Selecteer Aanmaken.
Lees de waarschuwing in het formulier. Een sleutel geeft volledige adminrechten voor je studio, inclusief klantgegevens en betalingen. Deel de sleutel alleen met tools en mensen die je vertrouwt.
Je sleutel opslaan
Nadat je op Aanmaken hebt geklikt, toont het venster Sla je API-sleutel op de sleutel. Dit is de enige keer dat je deze ziet.
Selecteer Sleutel kopiëren en bewaar deze in een wachtwoordmanager. Deel de sleutel niet via e-mail of chat.
Selecteer Headers kopiëren om te kopiëren wat je tool bij elk verzoek moet meesturen.
Selecteer Sluiten.
Als je het venster sluit voordat je hebt gekopieerd, vraagt bsport je om een bevestiging. Als je toch sluit, kun je de sleutel niet meer bekijken: maak een nieuwe sleutel aan en trek de eerste in.
Je tool koppelen
Je tool stuurt bij elk verzoek aan de bsport API twee headers mee:
Header | Waarde |
| De toolnaam die je hebt gekozen. |
| De sleutel die je hebt gekopieerd. |
Endpoints en voorbeelden vind je in de API-documentatie.
Een sleutel intrekken
Zoek de sleutel in de lijst op het tabblad API.
Selecteer Sleutel intrekken.
Bevestig in het venster API-sleutel intrekken?.
De tool stopt onmiddellijk met werken en dit kan niet ongedaan worden gemaakt. De sleutel blijft in de lijst staan met de status Ingetrokken en de intrekkingsdatum. De toolnaam komt weer beschikbaar.
Een sleutel vervangen voordat deze verloopt
Sleutels kunnen niet worden bewerkt of verlengd. Om er een te vernieuwen:
Maak een nieuwe sleutel aan met een nieuwe toolnaam, bijvoorbeeld
reporting-tool-2, of hergebruik de naam zodra de oude sleutel is verlopen of ingetrokken.Werk je tool bij met de nieuwe sleutel.
Trek de oude sleutel in.
Hoe het werkt
Instellen. Een Owner of Admin maakt de sleutel aan en kopieert deze één keer.
Activeren. De sleutel werkt zodra hij bestaat. Je tool stuurt de twee headers mee bij elk verzoek.
Normaal gebruik. De lijst toont de status van elke sleutel.
Na de actie. Trek een sleutel in om deze meteen te stoppen, of laat hem verlopen.
Sleutelstatussen
Status | Betekenis |
Actief | De sleutel werkt en verloopt over meer dan 30 dagen. |
Verloopt binnenkort | De sleutel werkt en verloopt binnen 30 dagen. Plan de vervanging ervan. |
Verlopen | De sleutel heeft de vervaldatum bereikt en werkt niet meer. |
Ingetrokken | Je hebt de sleutel ingetrokken. Deze werkt niet meer. |
In de kolom Contact geeft Jij de sleutels aan waarbij je eigen e-mailadres staat vermeld.
Belangrijk om te weten
Eenmalige weergave. bsport slaat de sleutel niet leesbaar op. Niemand kan hem opnieuw tonen, ook bsport niet.
Limiet van 50 sleutels. Een studio kan 50 niet-ingetrokken sleutels hebben. Verlopen sleutels tellen mee totdat je ze intrekt. Bij het bereiken van de limiet toont de pagina een waarschuwing en kan het aanmaakformulier niet worden verzonden: trek een verlopen sleutel in om een nieuwe aan te maken.
Unieke toolnamen. De naam mag niet overeenkomen met die van een actieve sleutel. Verlopen en ingetrokken sleutels maken hun naam weer vrij.
Volledige toegang. Een sleutel is niet beperkt tot één onderdeel van je studio. Maak per tool een aparte sleutel aan, zodat je één tool kunt intrekken zonder de andere te beïnvloeden.
Abonnementswijzigingen. Als je bsport-abonnement de publieke API niet meer omvat, toont het tabblad API het upgradebericht en weigert bsport nieuwe sleutels.
Webhooks zijn afzonderlijk. API-sleutels maken geen webhooks aan. Zie "Je webhooks beheren".
Veelgestelde vragen
Ik ben mijn sleutel kwijt. Kan ik deze opnieuw bekijken?
Nee. Maak een nieuwe sleutel aan, werk je tool bij en trek de verloren sleutel in.
Waarom heb ik geen tabblad API?
Het tabblad is alleen voor Owners en Admins. Vraag een van hen om de sleutel aan te maken.
Waarom zie ik "Upgrade je abonnement om de API te gebruiken"?
Je bsport-abonnement omvat de publieke API niet. Deze is inbegrepen bij Build, Engage en Elevate. Neem contact op met bsport om te upgraden of de functie toe te voegen.
Voor wie is het contact-e-mailadres bedoeld?
Dit is de persoon die bsport contacteert over de sleutel. Als je dit veld leeg laat, gebruikt bsport het e-mailadres van de studio-eigenaar.
Kan ik een vervaldatum kiezen?
Het formulier biedt 3 maanden, 6 maanden of 1 jaar.
Duurt het intrekken van een sleutel lang?
Nee. De tool wordt meteen geweigerd.