Öppna data
Med evenemangsapi:et kan man hämta ner data om de flesta evenemang som arrangeras i staden. Genom att inkludera något av våra plugin på din site, kan du snabbt och effektivt visa evenemang på din webbplats. Du kan också skapa mer avancerade tjänster genom att anropa apiet direkt.
APIet
Det API som används är WP REST API (v2.0). Endast metoder som hämtar data är tillgängliga och de kräver ingen autentisering (OAuth tokens eller API-nycklar).
Några användbara anrop är:
- Hämta alla evenemang – https://api.helsingborg.se/event/json/wp/v2/event/
- Hämta ett specifikt evenemang – https://api.helsingborg.se/event/json/wp/v2/event/1
- Hämta alla platser – https://api.helsingborg.se/event/json/wp/v2/location/
- Hämta en specifik plats – https://api.helsingborg.se/event/json/wp/v2/location/1
För att snabbt och effektivt hämta ut all data du behöver, kan du med ett anrop sammanställa länkad data (embedded data). Detta gör du genom att ange ?_embed på förfrågan. Till exempel: https://api.helsingborg.se/event/json/wp/v2/event/2651/?_embed
Information om hur sökvägarna är formaterade kan hittas på http://api.helsingborg.se/event/json/wp/v2/types/.
För en komplett lista på vilka anrop, parametrar och data som finns tillgängligt så läs igenom WP APIets dokumentation. Notera att location, event, person är en custom post types som håller datan i meta_data. För att hämta ut datan, kan du således använda samma parametrar som du hittar under ”posts” i api dokumentationen.
Vad skiljer vårt api från wp-api?
Vi har namngivit base-prefixet till /json/ istället för /wp-json/. Vi har aktivt valt att avregistrera nedanstående enpoints:
- /wp/v2/posts
- /wp/v2/pages
Vissa fält är borttagna vid utmatning, eftersom informationen kunde vara vilseledande. De nycklar vi har tagit bort är enligt följande:
- author (alltid användar id 1 vid automatimport)
- acf (data innehållande alla fält repeterat, fn. extern plugin men kan komma att implementeras i acf)
- guid (intern referens mot resurs som saknas)
- type (typen definieras i förfrågan, överflödig i respons)
- link (intern referens mot resurs som saknas)
För ”location” och ”contact” är innehållsfältet avregistrerat i sin helhet, eftersom det alltid kommer att vara tomt.
Grundläggande principer – Meta fält
När det gäller skräddarsydda meta-fält finns det några grundläggande principer som är bra att känna till. Om du skulle hitta något värde som strider mot principerna kan du göra en buggrapport via github.
- Ett värde måste alltid vara i ett korrekt definierat format (enligt den instruktion som du finner på /types/).
- Ett värde som inte uppfyller formatet returneras alltid som NULL.
- Ett värde som är tomt (läs blank sträng) retuneras alltid som NULL (samtliga nycklar skickas alltid med.).
Licens
All textdata som är tillgänglig via APIet är publicerat med licensen Creative Commons BY, dvs använd den gärna men referera alltid till källan. Tyvärr gäller denna licens ej för bildmaterial som kan vara tillgängligt via APIet, då Helsingborg Stad inte i alla fall äger rätten att sprida bilder vidare.