Als onderdeel van het aanmaken van nieuwe API-sleutels voor ontwikkelaars of het bewerken van bestaande API-sleutels voor ontwikkelaars in je account, kun je de toegang die de API-sleutel krijgt aanpassen. Met het afdwingen van scopes kun je controle uitoefenen over de directe toegang tot specifieke API-eindunten voor externe tools die aan je instituut zijn gekoppeld.
Het afdwingen van scoping is standaard uitgeschakeld bij het aanmaken van een nieuwe API-sleutel voor ontwikkelaars, waardoor tokens toegang hebben tot alle eindpunten die beschikbaar zijn voor de autoriserende gebruiker. Scopes kunnen echter op elk moment worden bewerkt voor een API-sleutel voor ontwikkelaars en toegangstokens voor de autoriserende gebruiker op de juiste manier bijwerken.
Opmerkingen:
- Ontwikkelaarssleutels beheren is een accountmachtiging. Als je geen ontwikkelaarssleutels kunt beheren, is deze machtiging niet ingeschakeld voor je gebruikersrol.
- Ontwikkelaarssleutels zijn niet beschikbaar in subacounts.
Account openen
Klik in Globale navigatie op de link Beheerder (Admin) [1] en klik daarna op de naam van het account [2].
Ontwikkelaarssleutels openen
Klik op de link Ontwikkelaarssleutels (Developer Keys) in Accountnavigatie.
Ontwikkelaarssleutel toevoegen
Klik op de knop Ontwikkelaarssleutel toevoegen (Add Developer Key).
API-sleutel toevoegen
Klik op de optie API-sleutel toevoegen (Add API Key).
Scopes afdwingen
Nadat je alle informatie over de ontwikkelaarssleutel hebt ingevuld, klik je op de knop Scopes afdwingen (Enforce Scopes).
Opnemen parameters toestaan
Klik in het selectievakje Opnemen parameters toestaan (Allow Include Parameters) om het gebruik van alle "includes" parameters voor deze sleutel toe te staan.
"Includes" parameters kunnen toegang verlenen tot aanvullende gegevens die niet zijn opgenomen in de tabel met eindpunten.
Eindpunten zoeken
Je kunt naar een specifiek eindpunt zoeken door de naam van het eindpunt in het veld Eindpunten zoeken (Search Endpoints) te typen [1].
Scrol door de tabel met eindpunten [2] om alle beschikbare eindpunten te bekijken.
Alleen-lezen eindpunten selecteren
Om alleen-lezen (GET) toegang tot de ontwikkelaarsleutel te verlenen, selecteer je het selectievakje Alleen-lezen (Read only). De tabel zal automatisch worden bijgewerkt en alle scopes die alleen-lezen eindpunten hebben weergeven.
Individuele eindpunten selecteren
Je kunt aangepaste toegang tot de API-sleutel voor ontwikkelaars verlenen. Klik op een scope-naam om de beschikbare eindpunten te bekijken [1]. Selecteer de gewenste eindpunten door het selectievakje naast de naam van het eindpunt aan te klikken [2]. De regel met de naam van de scope zal worden bijgewerkt en toont nu de samenvatting van de gezamenlijk geselecteerde eindpunttoegangen [3].
Sleutel opslaan
Klik op de knop Opslaan (Save).
