Om toegang tot de API te krijgen, is er een API key vereist. Een omgevingsbeheerder kan de API key aanvragen door in de leeromgeving naar Instellingen te gaan. Hier kan de omgevingsbeheerder op  API Keys Beheren klikken om één of meerdere API keys aan te maken.

De API key moet veilig bewaard worden. Wees voorzichtig naar wie je het stuurt en plaats het bijvoorbeeld niet in JavaScript code die door de browser wordt geladen. De API zou niet aangeroepen moeten worden vanaf de client kant.

De API key kan iemand potentieel toegang geven tot alle gebruikersgegevens in je leeromgeving.

Neem zo snel mogelijk contact met ons op als de API key in het geding komt. We kunnen de API key dan verwijderen, zodat deze niet meer gebruikt kan worden. We kunnen je dan van een nieuwe API key voorzien.

Voor verdere beveiligingsmaatregelen hebben we de mogelijk om twee soorten whitelists in te stellen per API key:

  • Whitelist op basis van IP-adres. Hiermee kan de API met deze API key alleen worden aangeroepen vanaf servers waarvan het IP-adres in de whitelist staat.
  • Whitelist op basis van API call. Hiermee kunnen alleen specifieke API calls worden gebruikt met deze API key. Als we bijvoorbeeld alleen addUser op de whitelist zetten, dan kan met deze API key alleen deze API call worden aangeroepen en zal elke andere API call een fout teruggeven.

Als je gebruik wilt maken van whitelisting, neem dan contact op met onze Support Heroes via support@anewspring.com.


Het volgende artikel legt uit hoe je de API kunt aanroepen en hoe je de API key kunt meesturen:

API - De API aanroepen en het outputformaat