Riksidrottsförbundets API:er

Följande API:er som är samlade i testmiljön i ett paket som heter RF API:

• Hämta genomförda utbildningar: hämta alla idrottsrelaterade utbildningar som en person har deltagit i, likt en utbildnings-CV, eller verifiera att personen har förkunskapskraven som krävs för en utbildning.
• Rapportera utbildningstimmar: utbildningsplattformar delar med sig av utbildningsdata (timmar, deltagare, status) som kan ligga till grund för statistik och bidragsfördelning. API:et kommer hantera SF-utbildningar och folkbildning för verksamhetsformerna kurs/utbildning, föreläsning och processarbete. Ej kulturarrangemang i dagsläget.
• Hämta person. Hämta personer, såsom medlemmar i föreningar inklusive persondata, från Riksidrottsförbundets centrala databaser till exempelvis ett föreningsadministrativt systen.
• Medlemsansökan. För föreningar som använder IdrottOnline som primärt medlemsregister och som vill ha ett ansökningsformulär på sin webbplats för personer som vill bli medlemmar i föreningen. Medlemsansökan hamnar direkt i IdrottOnline administration för hantering. Funktionen fanns tidigare på episerver hemsidan i IdrottOnline.
• Hämta organisation. Hämta organisationer med organisationsdata (exempelvis föreningar) från Riksidrottsförbundets centrala databaser. Ger mer information än Sök organisation.
• Sök organisation: skapar möjlighet att bygga tjänster för att söka efter organisationer inom svensk idrottsrörelse, t ex idrottsföreningar. Exempel på implementation, Hitta inom idrottsrörelsen
• Sök utbildning: skapar möjlighet att bygga tjänster för att söka efter utbildningar som erbjuds av svensk idrottsrörelse och finns i Riksidrottsförbundets och SISU Idrottsutbildarnas centrala databaser. Exempel på implementation, se sisuidrottsutbildarna.se
• Ansökan om namnbyte: skapar möjlighet för idrottsföreningar attt ansöka om namnbyte för sin förening. Ansökan om namnbyte: exempel på implementation
• Föreningsansökan. Skapar möjlighet att bygga tjänster som idrottsföreningar kan använda för att ansöka om medlemsskap i något av Riksidrottsförbundets anslutna specialidrottsförbund eller någon av SISU Idrottsutbildarnas medlemsorganisationer. Föreningens ansökan landar via API:et i IdrottOnline Administration där den mottagande organisationen kan hantera denna. Exempel på hur den är implementerad på rf.se.

För att få åtkomst till API:er i testmiljön:

1. Gå till Riksidrottsförbundets integrationsplattform i testmiljö
2. Skapa ett konto genom att klicka på SIGN UP
3. Prenumerera på RF API där uppdaterade versioner av RF:s API:er finns
4. Riksidrottsförbundet konfigurerar din åtkomst

Följande API:er som är samlade i produktionsmiljön i ett paket som heter RF API:

• Hämta genomförda utbildningar: hämta alla idrottsrelaterade utbildningar som en person har deltagit i, likt en utbildnings-CV, eller verifiera att personen har förkunskapskraven som krävs för en utbildning.
• Rapportera utbildningstimmar: utbildningsplattformar delar med sig av utbildningsdata (timmar, deltagare, status) som kan ligga till grund för statistik och bidragsfördelning. API:et kommer hantera SF-utbildningar och folkbildning för verksamhetsformerna kurs/utbildning, föreläsning och processarbete. Ej kulturarrangemang i dagsläget.
• Hämta person. Hämta personer, såsom medlemmar i föreningar inklusive persondata, från Riksidrottsförbundets centrala databaser till exempelvis ett föreningsadministrativt systen.
• Medlemsansökan. För föreningar som använder IdrottOnline som primärt medlemsregister och som vill ha ett ansökningsformulär på sin webbplats för personer som vill bli medlemmar i föreningen. Medlemsansökan hamnar direkt i IdrottOnline administration för hantering. Funktionen fanns tidigare på episerver hemsidan i IdrottOnline.
• Hämta organisation. Hämta organisationer med organisationsdata (exempelvis föreningar) från Riksidrottsförbundets centrala databaser. Ger mer information än Sök organisation.
• Föreningsansökan. skapar möjlighet att bygga tjänster som idrottsföreningar kan använda för att ansöka om medlemsskap i något av Riksidrottsförbundets anslutna specialidrottsförbund eller någon av SISU Idrottsutbildarnas medlemsorganisationer. Föreningens ansökan landar via API:et i IdrottOnline Administration där den mottagande organisationen kan hantera denna.
• Sök organisation: skapar möjlighet att bygga tjänster för att söka efter organisationer inom svensk idrottsrörelse, t ex idrottsföreningar.
• Sök utbildning: skapar möjlighet att bygga tjänster för att söka efter utbildningar som erbjuds av svensk idrottsrörelse och finns i Riksidrottsförbundets och SISU Idrottsutbildarnas centrala databaser.
• Ansökan om namnbyte: skapar möjlighet för idrottsföreningar attt ansöka om namnbyte för sin förening.

För att få åtkomst till API:er i Riksidrottsförbundets produktionsmiljö krävs ett avtal. Läs mer om detta och hur ni ansöker om att teckna avtal på sidan Licensavtal Integrationstjänster.

När avtalet är klart kan behörig teknisk kontaktperson registrera leverantören i Riksidrottsförbundets Integrationsplattform. API:erna nås sedan genom organisationens konto på RF:s integrationsplattform i produktionsmiljö.

Följande API:er har prioriterats och är planerade att levereras under kommande månader. Ytterligare justeringar görs löpande. När ett API är tillgängligt i både test- och produktionsmiljö tas det bort från nedanstående lista och beskrivs istället högre upp på sidan.

• Skapa, uppdatera, ta bort person: skicka personuppdateringar såsom kontaktuppgifter eller ny roll i förening från era system (tex. TA-system) till Riksidrottsförbundets centrala databaser.
  • I testmiljö: preliminärt september 2024.
  • I produktionsmiljö: preliminärt oktober 2024.
• Skicka in LOK-aktiviteter: skicka in utförda aktiviteter med dess deltagare för att underlätta administration och LOK-stödshantering.
  • I testmiljö: preliminärt januari 2025.
  • I produktionsmiljö: preliminärt februari 2025.
• Uppdatera organisation: skriv uppdaterad organisationsdata från ert verksamhetssystem eller från föreningssystem till Riksidrottsförbundets centrala databaser.
  • I testmiljö: under utredning.
  • I produktionsmiljö: under utredning.
• Hämta LOK-data: läs data från närvarorapporterade LOK-aktiviteter från Riksidrottsförbundets centrala databaser, till exempelvis statistik- eller analysverktyg, för att kunna följa utvecklingen av en idrott och möjliggöra datadrivna beslut.
  • I testmiljö: under utredning.
  • I produktionsmiljö: under utredning.
• Hämta aktiviteter: för föreningar som använder IdrottOnlines aktivitetskalender och vill visa aktiviteterna på sin webbplats utan dubbeladministration. Funktionen fanns tidigare på episerver hemsidan i IdrottOnline.
  • I testmiljö: under utredning.
  • I produktionsmiljö: under utredning.