Når API blir relevant utad
API blir relevant som offentlig dokumentasjon når det finnes et bevisst integrasjonsløfte, tydelig auth-modell, stabil kontrakt og avtalt supportnivå.
Åpenhet
Tydelig dokumentasjon av tilgang og omfang.
API blir relevant som offentlig dokumentasjon når det finnes et bevisst integrasjonsløfte, tydelig auth-modell, stabil kontrakt og avtalt supportnivå.
Når deler av API-et gjøres tilgjengelig utad, beskrives de med målgruppe, autentisering, rate limits, versjonering og støtteomfang.
Rutene og kontraktene er laget for appen og portalen. Et offentlig integrasjons-API er et eget produktspor og regnes ikke som tilgjengelig bare fordi rutene finnes.
Hva som er offentlig, og hva som er internt.
TapInn har en stor intern API-overflate mellom web, mobil og portalen. Denne siden forklarer hva som er laget for egne flater, og hva som skal til før noe dokumenteres som offentlig API.
Kortversjonen. Ikke alt som finnes som intern rute er ment som offentlig produkt-API. Offentlig dokumentasjon må være bevisst, stabil og støttebar.