Waarvoor is dit

Met de API-module koppel je eigen systemen aan VeldApp: opdrachtgevers, projecten, plangebieden, veldbezoeken en waarnemingen lezen en schrijven. Elke koppeling gebruikt een eigen sleutel met een rol, zodat je precies bepaalt wat een koppeling mag.

Een sleutel aanmaken

De pagina API-sleutels met de knop API-sleutel aanmaken en per sleutel naam, kenmerk, rol, laatst gebruikt, vervaldatum en status
  1. Open het organisatiemenu, API-sleutels en klik op API-sleutel aanmaken.
  2. De kolom Rol toont wat de sleutel mag. Je ziet ook wanneer hij voor het laatst is gebruikt.
Het formulier API-sleutel aanmaken met naam, rol, vervaldatum en de knop Aanmaken
  1. Naam: waarvoor de sleutel is, bijvoorbeeld de koppeling met de projectadministratie.
  2. Rol: kies zo beperkt mogelijk. Een rol die alleen mag lezen, volstaat voor een rapportagekoppeling.
  3. Verloopt op: laat leeg voor een sleutel zonder einddatum.
  4. Klik op Aanmaken.
Let op: de sleutel wordt één keer getoond. Kopieer hem meteen naar een wachtwoordkluis; daarna is alleen het kenmerk (de eerste tekens) nog zichtbaar.

Intrekken

Klik in de lijst op Intrekken om een sleutel ongeldig te maken, bijvoorbeeld als een koppeling stopt of een sleutel is gelekt. Maak daarna zo nodig een nieuwe aan.

Goed om te weten

  • De API kent 120 verzoeken per minuut per sleutel. Media, verwijderen en webhooks zitten niet in de API.
  • De technische documentatie (OpenAPI) sturen we op verzoek toe via [email protected].
  • De module API-koppeling zet je aan onder Abonnement.