Serveranrop (API)

Hämta ut och skicka in data från en annan server

Ofta vill man hämta rådata från Mina Aktiviteter till en egen webbserver för att kunna stuva om informationen och presentera den på lämpligt sätt. I andra fall vill man hämta nytillkommen information, exempelvis kursdeltagare eller eller ekonomiska data, till andra verksamhets- eller ekonomisystem. Det finns därför möjlighet att hämta en en stor mängd olika data via anrop från andra servrar.

Inloggning och behörighet (autentisering)

Vissa data kräver autentisering av den anropande servern. För andra data levereras olika mycket information beroende på eventuell autentisering.

Om du gör anropet från en vanlig webbläsare där du redan är inloggad som exempelvis administratör för en viss organisation behöver du inte ange vare sig organisationskoden eller organisationens lösenord eftersom systemet använder din befintliga inloggning för att kontrollera vilka data du är behörig att ta del av.

Om anropet sker från en annan server så är den anropande servern normalt aldrig inloggad. Systemet vet då inte vilken organisation som efterfrågas varför organisationskoden måste skickas med i anropet. Dessutom måste också organisationens lösenord skickas med i anropet om informationen du vill ha inte är helt publik..

För att specificera vilken organisation ni vill hämta data från skickar ni med parametern org=xxx, där xxx är organisationens unika kod. Vid hämtning av flertalet datatyper krävs även att ni antingen redan är inloggade eller att ni skickar med ett lösenord i anropet som pw=xxx.

I organisationsinställningarna har ni även möjlighet att ange ett IP-nummer för anropande server. Då måste anropet alltid ske från just det IP-numret. Det är inte nödvändigt att lägga in ett IP-nummer men ni är välkomna att göra det om ni vill minimera risken att obehöriga kommer åt era data.

Undvik om möjligt att skicka lösenord i webbadresser

Det är tillåtet att göra GET-anrop för att utbyta data, dvs att parametrarna placeras direkt i webbadressen som anropas. Parametrar i anropet krypteras alltid då anropet sker över https (SSL) men eventuella lösenord kommer att sparas i klartext i serverloggar. Det är därför bättre om parametrar i anrop skickas som POST, dvs så som vanligtvis sker då formulär postas från webbläsare till server.

Hämta data som XML

Begäran av XML-data sker genom ett anrop till webbsidan  https://minaaktiviteter.se/xml/. För att välja vilka data som skall sparas/hämtas skickar ni med parametern type=xxx. Utöver parametern type finns ett stort antal andra parametrar ni kan och ibland måste skicka med i anropet.

Översikt över tillgängliga data och format för utläsning/export

Data och format tillgängliga för utläsning liksom hur ni hämtar datat hittar ni i översikten på sida;Exportera filer i handledningen.

Addera / skicka in data (push)

Ni kan addera nya data genom ett anrop till webbsidan  https://minaaktiviteter.se/xml/. För att välja vilka data som skall adderas skickar ni med parametern type=xxx plus organisationskoden och organisationens lösenord i url:en. Därutöver skickar ni även med de data ni vill addera som ytterligare parametrar i url:en. Tillbaka får ni XML som visar vad som skett. Läs mer här om att addera data.

Skapa nytt eller påminna om användarkonto

Ni kan enkelt låta besökare registrera sig på er webbplats för att skapa ett konto som hanteras via Mina Aktiviteter. Kortfattat skickar ni in användardata och ber samtidigt Mina Aktiviteter att skicka en inloggningsnyckel till användaren samt skicka tillbaka användaren till er egna webbplats så snart användaren registrerat sitt nya konto. Läs mer här om att skapa/hantera ett användarkonto.

Autentisera användare

Genom att skicka ett användarnamn och ett lösenord har ni möjlighet att se om användaren finns registrerad inom er organisation och i så fall hämta grundläggande data om användaren. Svaret får ni i form av XML. Läs mer här om att autentisiera användare.

Vanliga variabler och deras innebörd

Typ av data Inlogg Filter Typkod Länk-exempel Övriga filformat

Individer

         
Hämta användare, individer och medlemmar Krävs   users

/xml/?type=users&name=Kalle Testare&email=kalle…

 
Individ         iCal

Aktiviteter och kalender

         
Hämta aktiviteter, läger, tävlingar och andra kalenderhändelser Ger mer   events

/xml/?type=events&org=*&pw=

 
Hämta endast aktiviteter öppna för anmälan Ger mer   courses

/xml/?type=courses&org=*&pw=

 
Kalender      

iCal-fil

 
Kalender      

RSS-flöde

 
Hämta bokningar till aktiviteter Krävs   bookings

/xml/?type=bookings&org=*&pw=

Närvaroformulär

Tävling

         
Tävlingar   games

/xml/?type=games

 

Ekonomi

         
Bokföringstransaktioner         SIE4

Status

         
Fråga efter aktuell status för anrop från den egna organsationen      

/xml/?type=status&org=*&pw=