API-sleutels aanmaken en beheren
Een API-sleutel autoriseert verzoeken aan de gegevensexport-API. U maakt API-sleutels
aan en beheert deze op Account Administration, en u voert de sleutel in wanneer u verzoeken indient via de API-verkenner-pagina
of vanuit uw eigen applicaties.
Elk verzoek aan de gegevensexport-API moet een geldige API-sleutel bevatten in de
x-api-key -koptekst. De sleutel verifieert het verzoek aan uw account (tenant).
Om API-sleutels aan te maken, dient u over Beheerder-toegang tot Account Administration te beschikken.
Gebruik de procedures in dit onderwerp om:
- Maak een nieuwe API-sleutel aan.
- Wijzig de naam, de vervaldatum of de beschrijving van een bestaande sleutel.
- Draai een sleutel om de geheime waarde ervan te vervangen zonder de identiteit van de sleutel te wijzigen.
- Verwijder een sleutel uit het systeem.
Opmerking: Wanneer u een API-sleutel aanmaakt of vervangt, is er een korte periode waarin de
sleutel nog niet is geregistreerd en nog niet klaar is voor gebruik. Over het algemeen
duurt dit minder dan één minuut.
- Om een nieuwe API-sleutel aan te maken:
- Klik in het linkerdeelvenster van Account Administration op API-sleutels.
- Klik op API-sleutel maken.
- Voer een naam en een beschrijving voor deze sleutel in.
- Kies voor Vervaldatum een datum die maximaal 367 dagen in de toekomst ligt.
- Kies voor Licenties het „RPI Data Export Usage Plan“ voor API-sleutels.
- Klik op Volgende.De sleutel is gegenereerd en opgeslagen.
- Klik op Kopiëren om de gegenereerde sleutel naar uw klembord te kopiëren. Bewaar het op een veilige
plaats. Belangrijk: De volledige sleutelwaarde wordt alleen weergegeven wanneer de sleutel wordt aangemaakt. U hebt er geen toegang meer toe. Indien u de waarde kwijtraakt, dient u de sleutel te vernieuwen om een nieuwe te genereren.
- Klik op Ik heb mijn sleutel opgeslagen om het dialoogvenster te sluiten.
- Om een bestaande API-sleutel te bewerken:
- Klik in het linkerdeelvenster van Account Administration op API-sleutels.
- Zoek de sleutel die u wilt wijzigen. Klik met de rechtermuisknop op de rij van de sleutel en selecteer API-sleutel bewerken.
- Pas de naam, de vervaldatum of de beschrijving indien nodig aan.Het bewerken van een sleutel heeft geen invloed op de waarde van de sleutel. Toepassingen die de sleutel al gebruiken, blijven zonder aanpassingen functioneren.
- Klik op OK.
- Om een API-sleutel te vernieuwen:
- Klik in het linkerdeelvenster van Account Administration op API-sleutels.
- Zoek de sleutel die u wilt draaien. Klik met de rechtermuisknop op de rij van de sleutel en selecteer API-sleutel roteren.
- Stel de parameter Overlappingsperiode in dagen in op het aantal dagen gedurende welke zowel de bestaande sleutel als de gewijzigde versie tegelijkertijd actief moeten zijn.
- Stel een nieuwe waarde Vervaldatum in voor de sleutel.
- Klik op OK.
- Klik op Kopiëren om de gegenereerde sleutel naar uw klembord te kopiëren. Bewaar het op een veilige
plaats. Belangrijk: De volledige sleutelwaarde wordt alleen weergegeven wanneer de sleutel wordt aangemaakt. U hebt er geen toegang meer toe. Indien u de waarde kwijtraakt, dient u de sleutel te vernieuwen om een nieuwe te genereren.
- Werk alle toepassingen, scripts of opgeslagen interactieve documentatiesessies die de sleutel gebruiken bij voordat de overlappingsperiode afloopt.
- Om een sleutel uit het systeem te verwijderen:
- Klik in het linkerdeelvenster van Account Administration op API-sleutels.
- Zoek de sleutel die u wilt draaien. Klik met de rechtermuisknop op de rij van de sleutel en selecteer Direct verwijderen.
- Selecteer in het dialoogvenster Ja, verwijder de sleutel.Deze stap is noodzakelijk, aangezien het verwijderen onomkeerbaar is. Nadat u de sleutel hebt verwijderd, kunt u deze niet meer herstellen.
- Klik op OK.
U kunt de nieuwe of bijgewerkte API-sleutel op de pagina met interactieve documentatie gebruiken om de gegevensexport-API te testen, evenals in elke toepassing die verzoeken naar de API verzendt.