De GetQR API is in bèta en beschikbaar voor geselecteerde workspaces. Details kunnen nog veranderen vóór de algemene release.
Voordat je begint
- Je bent de Admin van de workspace of een Editor. Viewers kunnen geen API-sleutel aanmaken of gebruiken.
- De Admin van de workspace heeft een actief abonnement.
Je API-sleutel aanmaken
1
Open je accountinstellingen
Open je accountinstellingen en ga naar API.
2
Genereer de sleutel
Klik op Generate API key.
3
Kopieer de sleutel
Toon de sleutel en kopieer hem. Sleutels beginnen met
sk_live_.Verzoeken authenticeren
Stuur de sleutel als Bearer-token mee in deAuthorization-header van elk verzoek:
De statuscontrole is het enige endpoint dat zonder sleutel werkt.
Toegang en rollen
- Rollen. Alleen de Admin van de workspace en Editors kunnen een API-sleutel aanmaken en gebruiken. Viewers niet.
- Workspace. Elke sleutel hoort bij één workspace, en elk verzoek wordt in die workspace uitgevoerd. Je hoeft geen workspace-ID mee te geven.
- Live controles. Bij elk verzoek wordt de toegang gecontroleerd op basis van je huidige rol en het abonnement van de Admin van de workspace. Je eigen abonnement telt niet mee. Wordt je rol gewijzigd in Viewer of loopt het abonnement van de Admin af, dan geven verzoeken
403terug tot de toegang is hersteld. Je hebt geen nieuwe sleutel nodig. - Verwijdering. Word je uit de workspace verwijderd, dan wordt je API-sleutel verwijderd. Word je opnieuw toegevoegd, genereer dan een nieuwe sleutel.
Je sleutel opnieuw genereren
Genereer de sleutel opnieuw als hij is uitgelekt of als iemand er toegang toe heeft gekregen die dat niet hoort te hebben.1
Klik op Regenerate
Ga in je accountinstellingen naar API en klik op Regenerate.
2
Bevestig
Klik op Regenerate key.
3
Werk je apps bij
Kopieer de nieuwe sleutel en vervang de oude overal waar je hem gebruikt.
Je sleutel veilig bewaren
Behandel de sleutel als een wachtwoord: iedereen die hem heeft, kan QR-codes in je workspace maken, wijzigen en verwijderen.- Bewaar hem in een omgevingsvariabele of een secrets manager, niet in de broncode.
- Roep de API alleen aan vanaf je server. Zet de sleutel nooit in een website, mobiele app of iets anders dat gebruikers kunnen inspecteren.
- Deel hem alleen met developers die hem nodig hebben.
- Genereer hem opnieuw zodra je vermoedt dat hij is uitgelekt.
Veelvoorkomende problemen
Ik krijg 401 met een sleutel die eerder werkte
Ik krijg 401 met een sleutel die eerder werkte
De sleutel is opnieuw gegenereerd, of je bent uit de workspace verwijderd en de sleutel is verwijderd. Kopieer de huidige sleutel uit je accountinstellingen of genereer een nieuwe.
Ik krijg 403 bij elk verzoek
Ik krijg 403 bij elk verzoek
Controleer of je rol Admin of Editor is en of het abonnement van de Admin van de workspace actief is. De sleutel werkt weer zodra de toegang is hersteld.
Ik krijg 404 "This endpoint is not available."
Ik krijg 404 "This endpoint is not available."
De API is in bèta en nog niet ingeschakeld voor je workspace.
Ik zie de API-instellingen niet
Ik zie de API-instellingen niet
Ze verschijnen alleen voor de Admin van de workspace en Editors, en alleen in workspaces waar de API is ingeschakeld.