Sleutels
Een sleutel maken, rechten per resource geven, en wat te doen als hij uitlekt.
Een sleutel maken
Section titled “Een sleutel maken”Beheer → API-sleutels → + Nieuwe sleutel. Geef hem een naam die zegt wie hem gebruikt (“Feedleverancier”, “Dashboard marketing”), kies per onderdeel wat hij mag en kies wanneer hij verloopt: over 30 dagen, 90 dagen, 1 jaar, of nooit. Sleutel maken kan pas als er een naam is en minstens één onderdeel niet op Geen staat.
De sleutel ziet eruit als ck_ plus veertig tekens en is één keer zichtbaar. Bewaar hem
in de kluis van de partij die hem gebruikt, niet in een mail.
Rechten
Section titled “Rechten”Per onderdeel kies je Geen, Lezen of, waar de API dat kan, Schrijven. Schrijven kan
op producten, voorraad en klanten; de rest is alleen lezen. Vraagt de sleutel iets op waar hij
geen recht op heeft, dan komt er een 403 — niet een lege lijst, zodat de bouwer meteen ziet
wat er mis is.
Elke schrijfactie via de API komt als één regel in het Audit log, met de naam van de sleutel (“1 voorraadregel bijgewerkt via de API”). Lezen wordt niet per verzoek gelogd.
Gebruik
Section titled “Gebruik”curl -H "Authorization: Bearer ck_xxxxxxxxxxxxxxxxxxxx" \ -H "Accept: application/json" \ "https://app.nexym.nl/api/connect/orders?per_page=25&page=1"Als hij uitlekt
Section titled “Als hij uitlekt”Trek hem in onder API keys; dat werkt meteen: elk verzoek met die sleutel krijgt vanaf dan
een 401. Maak daarna een nieuwe aan en geef die door. Een ingetrokken sleutel blijft in de
lijst staan tot je hem verwijdert; dan is hij definitief weg, met zijn gebruikscijfers.
In het Audit log staat wanneer de sleutel is gemaakt, gewijzigd, ingetrokken en verwijderd,
en op het sleuteloverzicht zie je wanneer hij voor het laatst is gebruikt.
Verkeer volgen
Section titled “Verkeer volgen”Operaties → API-verkeer laat per dag, per sleutel en per endpoint zien hoeveel verzoeken er waren, hoeveel er misgingen en hoe lang ze duurden, plus de geweigerde verzoeken: een ingetrokken of verlopen sleutel, een ontbrekend recht of te veel verzoeken. Onder Alerts kun je een melding krijgen als een sleutel binnen 14 dagen verloopt, of als in het afgelopen uur te veel verzoeken mislukten.