Skip to end of banner
Go to start of banner

OData API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

De OData API is publiek beschikbaar maar officieel nog in beta. Dat betekent dat functionaliteit mogelijk nog kan veranderen


De Planning.nl OData API geeft applicaties toegang tot vrijwel alle opgeslagen data van Planning.nl
Dit kan bijvoorbeeld software zijn om rapportages mee te maken (PowerBI, Excel, etc..) , of koppelingen die de data uitwisselen met Planning.nl
PowerBI en Excel hebben standaard ondersteuning voor OData.

De OData API is de opvolger van de SOAP/XML API, die op termijn wordt uitgefaseerd.
OData werkt met tabellen en velden genaamd entitysets en properties.
Een entityset (tabel) is altijd gekoppeld aan een entitytype waarin de velden gedefinieerd zijn van de tabel.
Op deze pagina krijg je een visueel overzicht van alle tabellen en velden.

Planning.nl maakt gebruik van versie 4 van de OData specificatie.

Huidige ondersteunde vormen van authenticatie zijn:

  • HTTP basic authenticatie
    Deze vorm werkt met een gebruikersnaam en wachtwoord

  • X-API-KEY in http header
    Het API token dat hiervoor nodig is kan een applicatiebeheerder genereren

Andere vormen van authenticatie worden in de toekomst mogelijk nog toegevoegd.

Voor toegang tot de API moet er een gebruiker bestaan met de rechten ‘webservice’.

Adres

https://app.planning.nl/OData/V1

Dit is de (base) URL van de OData API.

https://app.planning.nl/OData/V1/info

Informatiepagina met het overzicht van alle tabelen en velden in de OData API.
Dit is een geagreeerd overizcht van de informatie die ook in de OData metadata beschikbaar is.

https://app.planning.nl/OData/V1/$metadata

Het metadata document.
Hierin staan alle tabellen en velden die beschikbaar zijn via de API beschreven (in XML) .

  • No labels