API

API är en förkortning av ”Application Programmering Interface”. Detta är de gränssnitt som används när olika typer av applikationer ska kommunicera med varandra.

När vi talar mjukvara, så tillhandahåller många applikationer och operativsystem diverse typer av API:er som andra program kan använda sig av. I vissa fall är det interna API:er som bara används när en tillverkare/programmerares olika applikationer ska tala med varandra. I andra fall är det öppna API:er som kan användas av vilken annan applikation som helst. Genom att publicera öppna API:er möjliggör olika applikationer/tjänster att andra applikationer kan tillgodogöra sig data och dela funktionalitet sinsemellan. Detta kan vara allt ifrån småsaker som att läsa ut värden till att skapa avancerade grafer utifrån användardata.

API-dokumentation

Det är viktigt att API:et är väldokumenterad, så att programmerare lätt kan utnyttja API-tjänsterna på ett korrekt vis. Innan du väljer att börja använda ett API, se till att det finns gott om dokumentation och exempelkod som kan vägleda dig till hur API:et ska användas. Kolla även att det verkar vara ett API som är uppdaterat och underhållet, så att du inte finner att du byggt upp din applikation kring en tjänst som försvinner eller upphör att fungera av någon anledning.

Designa egna API

När vi designar en egen tjänst som andra ska kunna ta del av och använda i sina applikationer är det viktigt att vi designar ett bra API. Vi vill att gränssnittet ska vara likformig, förutsägbart och att det ska ha lång livstid. Vi måste tillhandahålla bra dokumentation som uppdateras i takt med tjänsten. Det är även bra att skapa många kodexempel som visar hur man kan utnyttja API:et på ett korrekt vis. I vissa fall kan API:ets utformning vara minst lika viktig som hur själva tjänsten fungerar.

Protokoll och API

Protokoll är ett annat begrepp vi brukar tala om när vi beskriver kommunikation mellan två parter. Protokoll handlar dock mer om flödet och ordningen i vilket systemen utbyter information. Man kan ha ett protokoll som anger i vilken ordning olika API-anrop ska utföras. För att läsa data ifrån en fil, måste vi t.ex. först öppna den, sen läsa ifrån den och till sist stänga den. Det kan ses som ett protokoll för hur API:et ska användas. Likaså kan ett API-anrop förstås implementera eller använda sig av ett eller flera protokoll när det utförs.