API key verkrijgen

Om te kunnen communiceren, dient u namens de organisatie waaronder u geregistreerd bent, een API-key te genereren. Onder het juiste abonnement kunt u een private- en public key genereren, of desnoods opvragen bij een accounthouder van de organisatie namens wie u API verzoeken wilt kunnen doen.

Goedkeuring vanuit gebruikersaccount

Na een API call namens een gebruiker, wordt de API koppeling bekend gemaakt in het profiel behorende bij de gebruiker. Via deze weg dient toestemming te worden gegeven om middels een api key namens de betreffende gebruiker met onze API te mogen communiceren. Op deze wijze houden de volgende partijen de mogelijkheid om toegang op te heffen:

  • de API key verstrekker;
  • de hoofd accounthouder van de organisatie waar registers en datalekken onder vallen;
  • de accounthouder van de profielgegevens welke gebruikt worden om mee te communiceren.

Indien er nog geen goedkeuring gegeven is, zal de response na een poging om via de API in te loggen, als volgt zijn:

{
    "status": 401,
    "error": "Not approved by user"
}

Elk opvolgende request zonder juiste toegang (en dus zonder verkregen token-code), zal de volgende melding opleveren:

{
    "status": 401,
    "error": "Missing user/token"
}