Voetbal Datacentre API

Dit is de documentatie voor Voetbal Datacentre API. Ieder hoofdstuk geeft een korte beschrijving van de API call, een formele syntax van de call, een lijst met mogelijke input parameters, een lijst met output parameters, een of meer voorbeeld calls en een voorbeeld output.

1 Initialisatie (1507 )

Beschrijving

In de initialisatie call word een 'pathname' meegegeven die uniek is voor iedere site. Wanneer deze pathname gecontroleerd en juist bevonden is word een sessie gecreeerd, het sessie ID PHPSESSID word dan terug gegeven

Wanneer de apiversion parameter niet word meegegeven zal altijd de meest aktuele versie van de API worden geactiveerd. Tevens is het in sommige gevallen mogelijk om een parameter apiversion mee te geven aan de call waardoor de API naar deze versie zal terug schakelen. Wanneer dit onmogelijk is zal een error terug gegeven worden.

Een succesvolle initialisatie resulteert in een Session ID die maximaal 24 uur geldig is. Dit Session ID key moet als GET-parameter voor elke volgende call worden meegegeven ("PHPSESSID"). Als het Session ID niet meer geldig is dient u een nieuw Session ID op te halen.

Tevens moet deze Session ID als een salt worden gebruikt voor de MD5 hash, welke verder gebruik maakt van de statische key die door voetbaldatacentre wordt verstrekt.

De MD5 hash wordt gegenereerd op de volgende wijze:

md5('<key>' . '#' . '<url_path>' . '#' . '<session_id>');

Om alle teams op te halen, heeft u de volgende hash nodig:

md5(key#/teams#session_id);

'key' is hierbij:

De 'secret key' die aan app ontwikkelaars is verstrekt, of
De API sleutel die de sitebeheerder via het admin interface kan verkrijgen indien het API product besteld is.

Beide bovenstaande keys kunnen gebruikt worden om een hash te genereren.

bijv. md5('mobapi_static_key#clubs/BB44ABC/results#eff1a8d6311bb132338681570456fbcd');

url_path is hierbij gelijk aan de waarde die in de GET parameter pathname wordt meegegeven.

Deze waarde moet eveneens als een GET parameter hash worden meegestuurd met elke volgende request.

Indien de meegegeven Session ID reeds verlopen is, of indien de controle op basis van deze hash aan onze zijde fout gaat, wordt de volgende foutmelding getoond:

{"error" : { "errorcode" : "9992", "message" : "Hash not correct"}}

NB: De standaard vereist het aanwezig zijn van de header 'HTTP_X_APIKEY'. Deze waarde is ter identificatie van de aanroepende partij.

Beschikbaarheid

API: U heeft een API sleutel nodig.

Syntax

https://api.voetbaldatacentre.nl/api/initialisatie/<pathname>[&apiversion=1.0]

Input parameters

pathname: Unieke pathname voor de club zoals vastgelegd in het admin interface.
apiversion: Deze parameter is optioneel; in sommige gevallen kan er een bepaald versie nummer van de API mee afgedwongen worden.

Output parameters

error: Error code als er een fout was of
PHPSESSID: Session ID
clubnaam: Volledige naam van club
apiversion: Versie van de API
changed: Datum en tijd waarop de laatste wijziging heeft plaatsgevonden
changelog: URL van changelog waar aanwezige versie van de API kunnen worden gecontroleerd
logo: URL van clublogo
kleuren: Een array van kleuren die ingesteld zijn voor de app
rss: nvt
twitter: nvt
twittertags: nvt
appsponsor: nvt

Output

{
    "errorcode":1000,"message":"Ok",
    "List":[{
    "PHPSESSID":"s39fu9pq33990qhvbj97sl1g47",
    "clubnaam":"zvv ZILVERMEEUWEN - ZAANDAM",
    "apiversion":"1.0",
    "changed":"2015-09-28 12:35:15",
    "changelog":"http:\/\/api.knvbdatacentre.nl\/api\/changes?version=1.0",
    "logo":"http:\/\/bin617.website-voetbal.nl\/sites\/voetbal.nl\/files\/knvblogos\/BBFX33T.jpg",
    "kleuren":{
    "foreground":"ffffff",
    "background1":"0000ff",
    "background2":"5656ff",
    "verloop":"1"
},"rss":[{
    "bron":"http:\/\/www.forza-almere.nl\/?feed=rss2",
    "rssdefault":1,"prof_rss":1
},{
    "bron":"http:\/\/optioneel.cms.nl\/?feed=admin",
    "rssdefault":0,"prof_rss":0
}],"twitter":[{
    "type":"account",
    "value":"@vvzilvermeeuwen"
}],"twittertags":["a",
    "b",
    "c"],"appsponsors":[{
    "naam":"FOEKENS",
    "url":"http:\/\/www.foekens.nl",
    "banner":"http:\/\/knvbdatacentre.nl\/sites\/all\/themes\/knvbdatacentre\/images\/appsponsor\/1384978675.JPG"
},{
    "naam":"Vonk Sports",
    "url":"http:\/\/www.vonksports.nl\/",
    "banner":"http:\/\/knvbdatacentre.nl\/sites\/all\/themes\/knvbdatacentre\/images\/appsponsor\/1411842644.JPG"
}]
}]
}