Handleiding voor ontwikkelaars
Naslaginformatie over scopes
Met fijnmazige machtigingsbereiken kun je beperken waartoe een API-sleutel of OAuth-client toegang heeft binnen een werkruimte.
Overzicht
Scopes zijn door spaties gescheiden tekenreeksen die aan een API-sleutel of OAuth-client zijn gekoppeld. Wanneer een verzoek binnenkomt, valideert de API de scopes van het token aan de hand van de uitgevoerde bewerking. Dit volgt hetzelfde model als GitHub en Stripe: vertrouwd, controleerbaar en gemakkelijk om over te redeneren.
Scopes zijn optioneel. Als er geen bereiken zijn opgegeven, heeft de referentie volledige toegang tot de werkruimte (equivalent aan een werkruimtebeheerder). We raden u aan de minimale bereiken toe te wijzen die nodig zijn voor elke integratie.
Scopes
| Bereik | Wat het biedt | Methoden | Eindpunten |
|---|---|---|---|
polls:read | Lees pollen, hun inhoud en metadata. | GET | /polls, /polls/{id} |
polls:write | Polls maken, bijwerken en verwijderen. | POST, PATCH, DELETE | /polls, /polls/{id} |
results:read | Lees de verzamelde resultaten per dia en de kiezerslijst. | GET | /polls/{id}/results, /polls/{id}/responses, /polls/{id}/votes |
responses:write | Verzend antwoorden en stemmen voor pollen. | POST | /polls/{id}/responses, /polls/{id}/votes |
sessions:write | Creëer en beheer live presentatorsessies. | POST | /sessions, /sessions/{id}/control |
sessions:read | Lees live sessiestatus (status, huidige dia, aantal deelnemers). | GET | /sessions/{id} |
media:write | Upload en proxy media (afbeeldingen, YouTube) voor gebruik bij vragen. | POST | /media |
export:read | Download de enquêteresultaten als CSV-bestand of als PDF-rapport. | GET | /polls/{id}/export |
ai:write | Gebruik AI om poll-inhoud te genereren. | POST | /polls/{id}/branch |
Scopes op API-sleutels
API-sleutelbereiken worden afgedwongen op elk verzoek. Een sleutel die is gemaakt met een niet-lege scopeset mag alleen eindpunten aanroepen die onder deze scopes vallen. Een verzoek dat een scope nodig heeft die de sleutel mist, retourneert 403 onvoldoende_scope. Een sleutel gemaakt met no scopes heeft volledige toegang tot de werkruimte (zie Standaard hieronder). Wijs het bereik van een sleutel toe wanneer u deze maakt in de Ontwikkelaarsportal.
Scopes op OAuth-clients
OAuth-clients dwingen scopes af op het moment van tokenuitgifte. Wanneer u POST /api/oauth/token aanroept met een parameter scope, worden alleen bereiken toegekend die aan de client zijn toegewezen tijdens het maken. Het aanvragen van een niet-toegewezen bereik wordt stil van het token verwijderd.
Als er geen scope wordt verzonden in het tokenverzoek, neemt het token alle scopes over die aan de client zijn toegewezen (of volledige toegang als de client geen scopes heeft).
Zie de OAuth 2.0-handleiding voor een volledige installatiehandleiding.
Standaard (geen scopes gespecificeerd)
Inloggegevens waaraan geen scopes zijn gekoppeld, hebben volledige toegang tot de werkruimte, equivalent aan een werkruimtebeheerder. Gebruik dit voor:
- Persoonlijke automatisering waarbij u eigenaar bent van de werkruimte
- Prototyping en ontwikkeling
Voor productie-integraties die worden gedeeld door teams of derden, specificeert u altijd de minimaal vereiste scopes.
Nog vragen?
Ons team helpt je graag verder.