API:er

Ett API låter andra system prata med din tjänst. Ett bra API kan bli en försäljningsfördel, men det är också ett löfte till kunderna som måste hållas stabilt och säkert.

Stabilitet

Kunder bygger sina system mot ditt API. Ändringar som bryter bakåtkompatibiliteten ska versioneras och aviseras i god tid.

Säkerhet

Kräv autentisering, ge bara de behörigheter som behövs och begränsa antalet anrop.

Dokumentation

Tydlig dokumentation med exempel gör att fler kommer igång – och minskar supportfrågorna.

Gör så här

Bestäm vilka funktioner API:et ska exponera.
Inför autentisering och behörigheter från start.
Versionera API:et och skriv en policy för hur ändringar aviseras.
Dokumentera med exempel och testa dokumentationen på en ny användare.

Vanliga misstag

Att ändra API:et utan förvarning och därmed bryta kundernas integrationer.
Att lämna ut för breda behörigheter.

Behandla API:et som en egen produkt med egna användare.