Utvikling
Slik bygger du API-er og integrasjoner som kan vedlikeholdes
Vedlikeholdbare API-er og integrasjoner trenger tydelige kontrakter, kontrollert feilhåndtering, sporbarhet og ansvar for endringer på begge sider.
En integrasjon lever lenger enn første leveranse
Det er ofte enkelt å få to systemer til å utveksle data i et kontrollert eksempel. Den virkelige utfordringen kommer senere, når data mangler, et felt endrer betydning eller ett av systemene er utilgjengelig.
En vedlikeholdbar integrasjon må derfor være utviklet for endring og feil, ikke bare for den første vellykkede forespørselen.
Definer en tydelig kontrakt
API-et bør beskrive hvilke data som forventes, hvilke felt som er obligatoriske og hvordan feil kommuniseres. Det bør også være tydelig hvordan autentisering, versjonering og bakoverkompatibilitet håndteres.
En dokumentert kontrakt gjør det mulig å utvikle og teste systemene hver for seg. Den reduserer også risikoen for at små endringer på én side får uventede konsekvenser på den andre.
Håndter feil som en normal situasjon
Nettverk og eksterne tjenester vil feile. Integrasjonen må vite:
- hvilke forespørsler som kan prøves på nytt
- hvordan duplikater unngås
- hva som skal lagres for senere behandling
- når et menneske må varsles
- hvordan en delvis gjennomført operasjon ryddes opp
Feilmeldinger må gi nok informasjon til å finne årsaken uten å eksponere sensitive data.
Gjør dataflyten sporbar
Når noe mangler i målsystemet, må det være mulig å finne ut hva som skjedde. Strukturerte logger, korrelasjons-ID-er og relevante måledata gjør det mulig å følge en operasjon gjennom flere tjenester.
Sporbarhet er særlig viktig når integrasjonen behandler innhold eller bruker AI. Da bør systemet også kunne vise hvilken kilde, regel eller modellversjon som påvirket resultatet.
Avklar eierskap
Teknologien er bare én del av integrasjonen. Noen må eie datadefinisjonene, håndtere varsler og koordinere endringer mellom systemene. Uten tydelig ansvar blir små avvik liggende til de har blitt et driftsproblem.
En god integrasjon er ikke den med mest avansert arkitektur. Det er den som leverer forståelig data, tåler forventede feil og kan endres uten at alle involverte må gjette hvordan den fungerer.