Met de API van Claire kunnen gebruikers informatie ophalen voor gebruik in klantspecifieke systemen. Hiervoor is een API-sleutel nodig, die kan worden gegenereerd door een gebruiker met de rol Dealer Admin. Deze unieke API-sleutel geeft toegang tot dealerinformatie (en bijbehorende locaties). Hieronder volgen de stappen voor het aanmaken van een API-sleutel:
In Claire vind u de Claire API pagina in het hamburgermenu aan de linkerkant:
API overeenkomst
Als dit uw eerste bezoek aan de Claire API-pagina is, moet u akkoord gaan met de algemene voorwaarden voor het gebruik van de API. Als u niet akkoord gaat, kan er geen sleutel worden gegenereerd.
Sleutel aanmaken
Nadat op de knop API-sleutel maken in de linkerbovenhoek is geklikt, verschijnt er een menu waarin om verschillende gegevens wordt gevraagd:
Het is verplicht om alle velden in te vullen voordat er op Opslaan wordt geklikt.
Het is belangrijk dat deze velden met de juiste informatie worden ingevuld. De contactgegevens moeten overeenkomen met de persoon die de API-sleutel daadwerkelijk zal gebruiken. Mocht er zich een probleem, wijziging of andere kwestie voordoen waardoor Claire contact moet opnemen met de sleutelhouders.
De sleutel wordt op onderstaande manier weergegeven op de pagina:
API sleutel tonen
Na het aanmaken van kunt u de sleutel delen door op Toon API sleutel te klikken.
Er verschijnt een pop-upvenster waarin wordt gevraagd om de reden voor het aanvragen van de API-sleutel in te voeren. Deze informatie wordt opgeslagen in het logboek.
Zodra dit is voltooid en bevestigd, wordt de API-sleutel weergegeven. Klik op het kopieerpictogram naast de API-sleutel om deze naar uw klembord te kopiëren, waarna u deze kunt delen.
Raadpleeg onze
API-documentatie voor instructies over het gebruik van de API en de bijbehorende sleutel.
Sleutel intrekken
Als de sleutel niet langer in gebruik is kunt u de toegang tot de sleutel Intrekken.
Daarna verschijnt een pop-up om dit te bevestigen.
Wanneer dit is bevestigd is het niet meer mogelijk om de sleutel te delen.