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

Ibland vill man hämta rådata 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 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.

Visa integrationsstöd i adminverktyget (inloggning krävs)

Nytt JSON-api beskrivet i OpenAPI

Det tidigare XML-api:et kommer inte att vidareutvecklas utan kommer istället ersättas av ett nytt json-baserat api. Det ny api:et är ännu inte helt klart men ni kan redan nu testa det. Informationen på denna sida beskriver det nya JSON-API:et. Vissa justeringar av nya API:et sannolikt kommer att ske under vintern 2023/2024.

Ni hittar även en beskriving av API:et enligt OpenAPI på länken här under.

minaaktiviteter.se/api/public/openapi.yml

Hämta data

Begäran av JSON-data sker genom ett anrop till webbsidan  /api/public/type/?org=orgCode. Parametern ”org” är er unika organsiationkod och”type” talar om vilken typ av data som skall sparas/hämtas. Utöver parametern type finns ett stort antal andra parametrar ni kan och ibland måste skicka med i anropet.

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. Det gör ni genom att skicka med parametern org={orgCode}, där {orgCode} är er organisations unika kod inom systemet.

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={Något starkt lösenord!}. Även om det är tillåtet att skicka lösenord i url:en (som GET-variabel) så är det rekommenderat att ni skickar det som en POST-variabel eftersom det då inte exponeras lika lätt.

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.

Addera / skicka in data (push)

Ni kan addera nya data på liknande sätt som ni hämtar data. De data ni vill addera skickar ni med som POST- eller GET-variabler. Tillbaka får ni JSON-data som visar vad som skett.

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 Idrott.se. Kortfattat skickar ni in användardata och ber samtidigt Idrott.se att skicka en inloggningsnyckel till användaren samt skicka tillbaka användaren till er egna webbplats så snart användaren registrerat sitt nya konto.

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 JSON.