Om je snel een inzicht te geven in de structuur en terminologieën van Club.Dataservice zetten we hier een aantal begrippen voor je op een rij:
Client ID
Na het bestellen van het product Club.Dataservice krijgt de vereniging de beschikking over een Client ID. Deze Client ID wordt is zichtbaar op het tabblad Clubsite bij het gebruikersbeheer in Sportlink Club.
Op het artikel list na moet elk artikel uit Club.Dataservice worden aangeroepen met vermelding van de Client ID.
Artikelen
Het product Club.Dataservice is opgebouwd uit een lijst van artikelen (webservices). Deze artikelen leveren informatie vanuit de ledenadministratie van de vereniging. Een overzicht van deze artikelen kun je vinden op de pagina Lijst met artikelen van Club.Dataservice. Je kunt de lijst met artikelen rechtstreeks benaderen via https://data.sportlink.com/list. De teams van de vereniging haal je bijvoorbeeld op met de aanroep https://data.sportlink.com/teams?client_id=<uw_ClientID>
Je kunt ook gebruik maken van een eenvoudig hulpmiddel om de data te testen, te structureren en in te stellen: de Javascript Library.
Parameters
Sommige artikelen vereisen ook (input-)parameters die mee moeten worden gegeven. Sommige parameters (arguments) zijn verplicht en sommige zijn optioneel. Het opgeven van parameters beïnvloedt het resultaat van de webservice. Parameters van artikelen worden via een GET request meegestuurd.
Scope (inloggen)
Sommige artikelen hebben een scope. Dit betekent dat je deze data niet zo maar mag ophalen. De gebruiker van de website moet eerst ingelogd zijn. De accounts voor deze gebruikers kunnen worden geactiveerd in Sportlink Club, bij het gebruikersbeheer op het tabblad Clubsite. De authenticatie wordt gedaan en verdere afhandeling gebeurt op basis van een token. Meer hierover kun je lezen op de pagina Club.Dataservice en de "Mijn omgeving".
Privacy
Binnen Sportlink heeft elk individu een privacy-niveau. Een lid kan door middel van dit privacy niveau bepalen welke informatie gedeeld wordt. Zie de pagina Sportlink en Privacy voor meer informatie over privacy of kijk op de Lijst met artikelen van Club.Dataservice voor meer informatie over de impact van het privacy niveau op de data van een specifiek artikel.
Keuzelijsten
Keuzelijsten worden gebruikt om bij een veld een drop-down menu met keuzes te kunnen presenteren.
Bij de webservice Teams zijn bijvoorbeeld parameters beschikbaar voor teamsoort, geslacht, spelsoort, competitiesoort en leeftijdscategorie. De waarden in het drop-down menu worden opgehaald door middel van de "keuzelijst-webservices".
Benodigde kennis
Het is lastig aan te geven welke kennis precies nodig is voor het werken met Club.Dataservice. Het is afhankelijk waar je Club.Dataservice voor wilt inzetten welke kennis vereist is. Voor het werken met Club.Dataservice voor een website is kennis en ervaring met HTML, CSS en Javascript een pré.
Javascript library
Sportlink heeft een eenvoudig hulpmiddel ontwikkeld, de Javascript Library om je te helpen bij het gebruik van de artikelen en het testen van de data. Je hebt voor het gebruik van dit hulpmiddel de Client ID nodig. Via deze tool kun je eenvoudig inzien:
- welke webservices er zijn,
- welke parameters er zijn,
- of parameters verplicht zijn,
- welke velden in het resultaat zitten
Via dit hulpmiddel kun je ook HTML-code genereren die je kunt opnemen in een website. Deze code vind je onder het kopje HTML op de pagina van een webservice. Meer informatie over het toepassen van deze code vind je op de pagina Toepassen Club.Dataservice en werken met de Javascript Library.