Hej 👋🏼
Vid 2 tillfällen under lunchtid på Innovationsveckan kör vi en API-workshop för dig som vill lära dig hur APIer fungerar.
Vi kommer gå igenom en hel del uttryck och du bekantar dig med ett verktyg (POSTman) som du kan använda för att utforska och testa APIer.
Du använder ett API på riktigt (46elks) under workshopen och när vi är klara har du skickat dig själv ett SMS genom ett API!
Vi välkomnar alltid frågor, så passa gärna på att fråga under workshopens gång!
Förberedelser
- Ladda ner och installera POSTman app.
Psst! Känner du dig osäker på vilket operativsystem du har?
Välj Windows x64 om du har en PC, sitter du på Mac så klickar du på download. - Skaffa ett konto: 46elks.
- Maila carolina@46elks.com för att anmäla dig 🙂
Vad är ett API och när är det relevant att använda APIer?
- Tillgängliggöra data
- Automation
- Lager som täcker komplexitet
Terminologi
Dessa begrepp kommer du att bekanta dig med under workshopen:
- url
- request
- response
- status codes
- docs
- GET & POST
- Authentication
- format (json, xml, other)
- Öppna data
- www-formurl-encoded
Du kommer lära dig!
Vi går igenom terminologi och förkortningar du inte hört tidigare, och det är poängen.
Du är med på workshopen för att lära dig. Ställ gärna frågor medan workshopen pågår!
Du kommer lära dig hur APIer fungerar genom att använda ett API på riktigt.
Anmälan
Maila carolina@46elks.com för att anmäla dig 🙂
Sammanfattning
- URL Adressen. Du har en hemaddress.
APIer har också egna hemadresser på internet. Precis som hemsidor.
Exampel: https://api.46elks.com/a1/SMS - När & varför använda APIer?
dataportal.se
Arbetsförmedlingens APIer
Trafiklab
20 APIer på 20 minuter - hjälp!?
Kontakta dem som tillhandahåller APIet
Stackoverflow ofta en räddare
Andra människor - gå på meetups, hackathons, besök olika forum... det är lättare att komma vidare när det finns andra som kan hjälpa dig - Request
- GET Be om data.
- POST Skicka in data. Trigga en händelse.
- Status codes
- 200 Allt väl.
- 404 Vi hittar inte det du letar efter!
- 20x OK!
- 30x Någon annanstans!
-
40xDu gör fel. Läs i dokumentationen (som också kan kallas manual, docs, API reference, kärt barn har många namn)
Be om hjälp!
Exempel: https://46elks.com/dennasidafinnsinte - 404. - 50x Hoppsan! Vi verkar ha gjort bort oss (vi har gjort fel!). Berätta gärna vad som strular eller försök igen senare.
- http cat
- Format
- json
{ key: "value", message: "Jordgubbarna fryser"}
- XML
<key>value</key>
<message>Jordgubbarna frysere</message>
- json
- Authentication
- Credentials
- API key
- Basic auth
- Värdehandling
- Övrigt
-
Hurra när APIet är väl strukturerat.
Då går det snabbt att dra slutsatser om hur det fungerar genom att kika på ett eller några exempel. Ibland kan det också räcka att se en URL. -
Hjälpsam dokumentation
Ibland finns gamla robusta APIer som är integrerade hos många där det finns värde i sig självt att det faktiskt inte rubbas på. Då kan du med god dokumentation ändå säkerställa en smidig effektiv och trevlig upplevelse för den eller de tekniker som ska integrera/implementera APIet. - Skicka in feedback och önskemål som användare.
-
Hurra när APIet är väl strukturerat.
- Kodexempel
Fler kodexempel i många olika programmeringsspråk hittar du på GitHub.
Python
import requests requests.post( "https://api.46elks.com/a1/SMS", auth = ("API_USERNAME", "API_PASSWORD"), data = { "from": "ElkWorkshop", "to": "+46766861004", "message": "Workshopen börjar! Har du installerat POSTman?" } )
