Tio saker att tänka på vid skapande av API

Idag är de flesta programvaror applikationer som knyter ihop annan mjukvarufunktion och på så sätt skapar en meningsfull och funktionell helhet. Denna sammanlänkning sker med hjälp av det vi kallar API, Application Programming Interface.

Ofta brukar man dela in API er i två olika grupper;

  • Sådana API som ger tillgång till olika typer av systemresurser, utan att bry sig om vilket operativsystem programmet kommer att användas på. Kallas ofta drivrutins API.
  • De API som ger tillgång till högnivåfunktioner som återanvänds. Det handlar ofta om mjukvara man får av andra leverantörer, för olika typer av beräkning eller datahantering.

Ska du skapa ett API finns det några saker att tänka på. Här listas tio punkter som kan vara bra att ha i åtanke:

1. Sätt ditt API under sitt eget domännamn, (exempelvis api.nn.se )
2. För över din data till en separat server, för att på så sätt göra ditt API redundant. Då är det inte beroende av din ordinarie tjänst, vilket är bra om du skulle få problem med denna då du får tusentals API-förfrågningar per sekund.
3. Vilket format ska du använda?
4. Behöver du ha en krypterad version av https? Bör anrop kanske vara signerade?
5. Om du vill ha koll på de som anropar ditt API, måste du ha en API- nyckel och skapa en registreringsprocess. Det finns otaliga sätt, men enklast är att använda Google Forms.
6. Inför en kontroll av anrop, och också begränsningar
7. Skapa en e-post lista eller blogg eller liknande där du bland annat kan informera om förändringar.
8. Vilken licens ska du använda?
9. Erbjud dokumentation om hur ditt API används. Berätta vad som finns och starta eventuellt ett forum för frågor.
10. Länka till dem som använder ditt API. Kanske ska du ta betalt?

Beträffande artikel

Kategorier: populär
Senast uppdaterad: April 1, 2013

Kommentarer

kommentarer

Powered by Facebook Comments