API voor Clubprofiel

API voor Clubprofiel

Wat is een API?

API is de afkorting voor Application Programming Interface. Met een API kunnen systemen met elkaar communiceren. Wanneer je data wil ophalen of uitwisselen vanuit een eigen systeem met ons systeem dan kan dit gedaan worden met onze API.

Wat kan je met onze API?

Met de API kan je jouw actviteiten / rooster, digitaal synchroniseren met het aanbod binnen de AH Sportactie en NSW. Zo kan je doorgeven wanneer er nieuwe sporters bij jouw club kennis kunnen maken in welke les. De API maakt het mogelijk de volgende data te synchroniseren en beheren binnen de AH Sportactie:

  • Aanbod aanmaken. Naam, tijd, sport, alle informatie die een potentieel nieuwe sporter weten moet kan uit jouw systeem in de actie geladen worden.
  • Hoe veel plaatsen je beschikbaar stelt binnen je les
  • Hoeveel plaatsen er gevuld zijn
  • Wie er komen sporten. Naam, telefoonnummer en het noodnummer worden via de API met je gedeeld

Hoe gebruik je de API?

Het systeem waarin jouw activiteiten / rooster digitaal zijn vastgelegd kan een verzoek sturen om informatie op te halen en/of te plaatsen in ons systeem. De API antwoordt met de opgevraagde data. De structuur waarin dit verzoek gedaan moet worden vanuit het systeem staat vast en is gedocumenteerd. Op die manier ben je ervan verzekerd dat je de juiste informatie in het goede formaat uitgewisseld wordt.

Ik wil dit ook! Hoe gaat dat?

In de volgende 4 stappen kun je aan de slag met onze API en automatisch je sportaanbod met ons systeem synchoniseren:

1. Neem contact op met IT

Neem contact op met je eigen IT afdeling/leverancier om te verifiëren of dit ook voor jouw sportclub mogelijk is. Het gebruik van de API is gratis, maar binnen het systeem waarin jouw activiteiten/ rooster digitaal zijn vastgelegd moet het mogelijk gemaakt worden om een verzoeken te sturen naar onze API. Mocht er technische ondersteuning nodig zijn dan kunnen daar wel kosten aan verbonden zijn.

2. Stuur ons een e-mail

 Stuur een mail naar api@nocsnsf.nl om toegang tot de API aan te vragen. Je ontvangt van ons de toegangssleutel (key) en technische documentatie om aan de slag te kunnen.

3. Test de verbinding

Sluit je systeem aan op onze API, test de verbinding en verstuurde data op ons testsysteem. Op die manier kun je altijd controleren wat er geplaatst gaat worden voordat de verbinding live is. Wel zo veilig!

4. Ga de API gebruiken!

Je kunt de API nu gaan gebruiken. Bij het gebruik van de API ga je akkoord met onze API gebruiksvoorwaarden