Malmöfestivalens öppna API
Här kan du studera och navigera Malmöfestivalens öppna API så att du kan få en förståelse för hur det fungerar.
Varmt välkommen att använda detta API för att skapa en iPhone-, iPad-, Android- eller Windows Phone7-app. Eller kanske ett native program för Windows, Linux eller Mac? Eller en webbsida?
Vi kräver ingen registrering, men om du registrerar dig så får du en api-nyckel och dessutom chansen att uppmärksammas av Malmöfestivalen. Bra och roliga lösningar listas på festivalens hemsida.
Hjälp oss att bli Sveriges bästa API 2012!
Obs att du måste registrera en api-nyckel för varje site du använder (api2011 och den skarpa api.malmofestivalen.se)
Dom olika api-siterna
Vi har lagt ut några olika siter med lite olika syften och data:
Senaste nyheter om apiet
Tweets från
@larskrantz med hashtag #mfestapi
Lite att tänka på
- Använd cachningen, det finns både last-changed och etag i de flesta fallen. I betatesten är cachningen kort, den blir längre i skarpa läget.
- Apiet stöder gzip och deflate, så använd en klient med stöd för detta.
- Http 503 Server Unavailable ges vid underhåll. Servern kommer snart igång igen.
- Övriga Http 500-fel är oförutsedda och om du kan ge oss info vad som orsakade det så blir vi glada.
- Http 401 kommer ges på /user/ - arean om du inte är autentisierad, och då gäller Basic Authorization.
Skicka med api-nyckeln som egen header och username och password i Authorization-headern.
Eller skicka det som tre querystrings:
?apikey=xxxx&emailaddress=användarensemail&password=lösenord i favoritanropen, det accepteras också.
Du kan få en access token också om du skickar in det till /user/authenticate/ sen använder du den token till att göra övriga anrop. Välj det som känns bäst.
Nu är det ju inga statshemligheter som döljer sig bakom favoriterna, så därför har vi valt enkelhet med Basic auth framför säkerhet.
- Http 200 säger att allt gick ok. Vid favorithantering med PUT och DELETE så får du bara en Http 204 No Content som alltid har tom body.
- Http 404 vid favorithanteringen säger dig att favouriteid var fel, dvs det finns inget sådant.
- Http 405 ges på /user/favourites/ om du inte använder ett tillåtet anrop. Endast PUT, DELETE och GET är tillåtet,
men om du gör ett anrop och skickar antingen med en header, formulärfält eller querystring med namnet X-HTTP-Method-Override och önskad metod ("PUT","DELETE","GET") så blir det den som gäller. Även en querystring eller formulärfält med namnet "_method" funkar.
- Det finns lite exempel på hur man kan använda jQuery för att prata med apiet här.
- Det finns inga villkor för att använda apiet annat än att registrering krävs om du hanterar en användares favoriter.
Datan som finns är offentlig och Malmö Stad önskar att den ska finnas tillgänglig samt uppmuntrar till kreativitet och egna initiativ.
Om du vill använda Malmöfestivalens hjärta för att spara favoriter så kan du länka dem direkt:
Stark färg = är en favorit
Svag färg = kan väljas som favorit
Observera!
Din lösning skall också för att fungera optimalt alltid kontrollera att datan som du visar är färsk, och inte blivit uppdaterad eller borttagen.