API – Hämta listor

I systemet finns en mängd olika listor, t ex listor över personer, aktiviteter, bokningar och betalningar.

Till de allra flesta listor kan ni själv skapa egna filter med olika sökkriterier och bestämma vilka kolumner/data som skall visas i listan. Dessa filter kan ni spara som filtermallar med egna namn. Sedan kan ni med hjälp av en API-nyckel anropa dessa filtermallar via en krypterad anslutning från externa servrar.

Ni kan alltid hämta data i bland annat CSV-, Excel – och JSON-format. Vissa listor har även egna exportformat såsom vCal, iCal, RSS eller SIE4.

Hämta en URL för ett API-anrop

För att generera den url ni behöver för att anropa en filtermall så loggar ni in i systemet och öppnar den lista ni vill hämta från en extern server.

I listan så skapar och sparar ni först den filtermall ni senare vill hämta. När ni gjort det så klickar ni verktyget för att öppna/använda filtermallar. Där der ni en symbol för att exportera filtret. När ni klickat på den så får ni direkt en url ni kan testa. Ni kan även justera och uppdatera anropet för att exempelvis få den i det format som passar er bäst.

Ytterligare anpassning av API-anropet

Förutom att ni i förväg när ni skapar filtret kan styra vilka data som kan hämtas kan ni även modifera det vid själva hämtingen. Om ni exempelvis hämtar en lista med bokningar och i hämtningsögonblicket vill begränsa er till att bara hämta bokningar till ett visst event trots att filtermallen inte är begränsad till det eventet så kan ni haka på variabeln event=någon-egen-event-kod.

Autientisering

Så länge ni är inloggade som administratörer behöver ni inte autentisera er när ni använder URL:en som ni skapat.

När ni hämtar listan från en extern tjänst behöver ni skicka med en egen API-nyckel med variabelnamnet pw. API-nyckeln kan ni skapa/hämta via era organisationsinställningar.

POST/GET

För att underlätta hanteringen så visar vi anropet med alla variabler direkt i URL:en. Det visas med andra ord som ett GET-anrop. Detta funkar också att när ni hämtar från andra servrar.

Om möjligt rekommenderar vi dock att ni skickar åtminstone token/lösenord som POST istället för GET eftersom det minskar risken för att nycklar av misstag exponeras i fel sammanhang. Variabelnamnen är dock desamma oavsett ni använder GET eller POST.

Undvik stora hämtningar

När ni ser en lista i vanliga adminvyn så ser ni vanligtvis bara ett tiotal rader även om listan har tio tusen träffar. Om ni däremot exporterar listan eller hämtar den via ett API-anrop så får ni med alla rader vilket kan ge extremt stora mängder data. Var därför mycket noga med att inte skapa anrop som hämtar mer data än vad som verkligen krävs.