Grensesnittkontrakt
En grensesnittkontrakt beskriver den avtalte datautvekslingen. Datastruktur, svar og betydning må passe sammen for begge parter.
En grensesnittkontrakt er den avtalte beskrivelsen av hvordan systemer skal utveksle data. Den omfatter forventede inndata, svar, feil og betydningen av tilbakemeldingene. En maskinlesbar beskrivelse kan uttrykke deler av dette; forretningsmessige avtaler må også være forståelige.
Dokumenter hva et svar betyr
I en oppdiktet kundeportal bekrefter en vellykket overføring først bare mottak hos en mellomkomponent. Det trengs en egen tilbakemelding for å vite om ERP har opprettet ordren. Hvis avsenderen tolker det første svaret som fullstendig behandling, passer bruken ikke med avtalen.
Sammenlign beskrivelse og implementering
OpenAPI definerer en standardisert beskrivelse for HTTP-API-er. Slike beskrivelser gjør tilgjengelige operasjoner og svar forståelige. De beviser ikke alene at en kjørende applikasjon oppfyller det avtalte forløpet. Kontroller passende eksempler og feiltilfeller mot implementeringen. Ved endringer må det også være klart hvilke deltakende systemer som bygger på hvilken avtale.
Kilder
Beslektede begreper
- JSON SchemaJSON Schema beskriver struktur og begrensninger for JSON-data. En validator sjekker reglene; at de følges, beviser ikke at innholdet er riktig for virksomheten.
- Transaksjonell inboxEn transaksjonell inbox bruker varige meldingsregistreringer for å beskytte lokal behandling mot doble leveringer.
- MeldingskvitteringEn meldingskvittering forteller meldingsmegleren at en levering er mottatt eller behandlet etter den avtalte regelen.
- Jitter ved nye forsøkRetry-jitter varierer ventetider tilfeldig for å spre nye forsøk og redusere samtidige forespørsler fra mange klienter.
- TestkundeområdeEt logisk avgrenset kundeområde i en multitenant-applikasjon, satt opp for kontroller.
- Ny sending av webhookNy sending av webhook overfører en melding på nytt. Planlagt gjenoppretting og replay-angrep krever ulike kontroller.
Artikler om temaet
API-er og integrasjon med ASES
ERP, CRM og nettbutikk ryddig koblet sammen