Utviklere

API-oversikt

Forstå autentisering, tilganger, idempotens, paginering og trygg integrasjonspraksis.

Start med API-referansen

Den offentlige API-referansen genereres fra Itemras OpenAPI-kontrakt. Bruk den for gjeldende operasjoner, forespørselsmodeller, responsmodeller og produksjonsadresse. Ikke utled felter fra nettapplikasjonen.

Autentiser med minst mulig tilgang

Opprett en egen API-nøkkel for hver integrasjon, og gi bare nødvendige tilganger. Lagre nøkkelen i en hemmelighetstjeneste, aldri i kildekode eller nettleserpakker. Roter den når eierskap endres eller eksponering mistenkes.

Send forespørsler trygt

Send JSON med dokumentert innholdstype. Følg markør- eller sidedata i stedet for å anta at første respons er komplett. Bruk idempotensnøkkel for støttede skriveoperasjoner, og ta vare på ressurs-ID-en som returneres.

Håndter feil

Behandle validerings- og konfliktresponser som permanente til input endres. Prøv midlertidige feil på nytt med begrenset eksponentiell venting og jitter. Logg Itemras sporings- eller korrelasjons-ID uten å logge nøkler eller sensitive data.

Fortsett

Åpne den offentlige API-referansen for maskinlesbar kontrakt og endepunkteksempler. Bruk webhooks for å reagere på endringer i stedet for kontinuerlig polling.