Nu går det att ställa frågor direkt via Andreas Krohns nya underbara API-konsoltjänst vid namn API HQ. Tjänsten gör det lätt och enkelt att testa olika frågor och se hur svar skickas och hämtas via JSON.
Skärmdump:
Besök konsolen för Bloggz.se bloggsök på följande URL:
Inatt exakt kl 00:00 så dök det upp ett antal nya ikoner i min Facebook-App på iPhone. Först trodde jag att det rörde sig om reklam för ett antal specifika appar såsom Ditto, Instagram och Gowalla. När jag klickar på ikonen så kom jag till appen om den är installerad och Appstore om den ej finns installerad.
Jag beslutade mig för att gå till botten med detta och drog igång Charles Proxy och tittade lite på JSON-trafiken och kunde då samtliga appar som listades under mitt Facebook-konto: Gowalla, Flixster,Texas HoldEm Poker, Rabble, Ditto, Kicksend, Wrapp, Marketplace, Bump,Spotify, foursquare, Instagram, Airbnb.
Några appar som listas men inte har attributet nativethirdpartyappicon: true är TripIt, Zerply och Earndit.
Min tes är att Facebook gör reklam för de appar jag har godkänt tidigare via webben exempelvis och då länkar till tillhörande iPhone (iPad?) app.
Skärmdump:
Så här ser JSON-strängen ut för Airbnb:
{"path":"fbrpc://nativethirdparty/f?fallback_url=itms%3A%2F%2Fitunes.apple.com%2Fapp%2Fid401626263&app_id=138566025676&access_token=BAAABORTKLIPPT&expires_in=3600&ref=search",
"photo":"https://fbcdn-photos-a.akamaihd.net/photos-ak-snc1/v85005/64/138566025676/app_1_138566025676_2800.gif",
"text":"Airbnb",
"uid":138566025676,
"type":"App",
"openinnewtab":true,
"nativethirdpartyappicon":true,
"paths":[],
"bootstrap":1}
Efter en hel del strulandes och ett fallskärmshopp senare så är nu API:et för bloggsökningen uppe igen och snurrar med en hel del nya härligheter.
För att sammanfatta:
Anropas på följande sätt:
http://api.bloggz.se/api.json?q=midsommar&type=trends
Vilket då returnerar en JSON som ser ut ungefär så här (gissa vilken dag midsommarafton inträffade 2011)
Om du enbart vill returnera antalet träffar för en sökfråga utan annat innehåll så slänger du på &type=hits på följande sätt:
http://api.bloggz.se/api.json?q=smsl%E5n&type=hits
Se även mitt blogginlägg om Bloggsök API version 1.
Se även Bloggsök API version 2.
En av de första webbtjänsterna jag byggde för egen räkning var Bloggz.se som är en bloggsökmotor som söker i svenska bloggar. I dagsläget så finns det runt 400 000 indexerade bloggar i dess databas. Oklart hur många av dessa som är aktiva men bloggar som ger felmeddelanden såsom 404 rensas fortlöpande bort. Även viss spam-filtrering sker. Nya bloggar upptäcks automatiskt med hjälp av ping.bloggnytt.se, en crawler samt BloggPing.
Antalet blogginlägg är i dagsläget 54 483 829 och innehåller inlägg från 2007 och framåt.
API:et nås på följande URL:
http://api.bloggz.se/api.json eller api.xml för XML-versionen. Det är fritt fram att använda API:et för icke kommersiellt bruk.
Möjliga parametrar är:
Skärmdump från JSON-data:
Om du använder API:et, så sätt gärna en User-Agent header med kontaktuppgifter såsom E-post.
Uppdatering: Håller på att uppdatera API:et så det kommer att fungera dåligt eller inte alls under 2-3 dgr.
Uppdatering 2: Nu fungerar det igen.
Så du går i tankarna på att tillhandahålla ett API? Då har du kommit rätt. Jag försöker här att redogöra över de tankar jag har när det gäller det mesta vid API utveckling.
Först och främst så bör du ställa dig frågan om ett API verkligen är rätt, och i de flesta fall så skulle jag säga att API är rätt väg. De fall då ett API kanske inte är lämpligt är då din tjänst enbart bygger på ett annat API och ej tillför något mervärde. Prioritering är också en viktig punkt, i flertalet fall så kan det tillåmed vara så att ett API skall finnas innan en webbsida finnes (framförallt i offentlig sektor).
Om du tillhandahåller en iPhone-app eller någon annan typ av extern tjänst så är detta också tillämpningsbart.
1. Placera ditt API under ett eget DNS-namn, exempelvis api.domän.se. Även om api.domän.se pekar till domän.se till en början.
2. Detta har med ovan punkt att göra: Exportera din data till en separat server som exempelvis ligger i molnet. Detta för att enkelt göra ditt API redundant och icke beroende av din ordinarie tjänst som kanske får problem om du får tusentals API-förfrågningar per sekund. Kan dock bli problem med realtidstjänster om API:et tillhandahåller sekundaktuell information.
3. Fundera om du bör tillhandahålla en krypterad version över HTTPS. Fundera även över om anrop bör vara signerade, för https i sitt standardutförande verifierar ej klient, bara server. Självklart kan du köpa SSL-certifikat via min sajt https.se.
4. Vilket format är lämpligast. JSON REST, XML SOAP eller annat? Jag rekommenderar REST JSON. Se Google eller FRAPI
5. Vill du hålla koll på vilka som anropar ditt API? Då bör du tillhandahålla en API-nyckel och bygga en registreringsprocess för detta. Enklast är att använda Google Forms. Det finns ofantligt många sätt att bygga detta förfarande.
6. Du bör införa kontroll av anrop samt begränsningar. Detta kan vara bra för att förhindra miljontals anrop i sekunden eller forcering av lösenord/användarnamn. Begränsa förfrågningar på så mycket som du bara kan, exempelvis IP-nummer.
7. Vilken licens kan användas? Här kan myndigheter få problem då CC-licenser kan gå emot lagstiftning. E-delegationen håller på med ett arbete om bl.a. detta och kommer att tillhandahålla mer information.
8. Upprätta en changelog, blogg eller E-postlista (Google Groups) för att berätta om eventuella förändringar. Här kan det även vara bra att prefixa alla API-anrop med versionsnummer för att bibehålla bakåtkompabilitet. Exempelvis: api.domän.se/v1/anropstyp
9. Glöm framförallt inte att erbjuda dokumentation och kod-exempel på hur API:et används. Berätta om innehållet, begränsningar, datatyper, relationer, statuskoder osv. Kanske ett forum för frågor? Wiki? Status-sida för att berätta om eventuella problem med ditt API eller fördröjningar. Se Pingdom eller Watchmouse.
10. Övriga punkter: Länka till de som använder ditt API för att uppmuntra användning. Ta betalt för ditt API? Berätta för Mashup.se att du har ett API. Hur länge bör du cacha? Pagination, page=1 vs. cursor: start_id=1234. Loggning? If-Modified-Since header?
That’s it! Har säkert glömt många bra saker, skriv en kommentar och berätta vad du saknar.