De Planning.nl OData API geeft applicaties toegang tot vrijwel alle opgeslagen data van Planning.nl
De OData API is de opvolger van de planning.nl SOAP/XML API, die op termijn wordt uitgefaseerd.
Applicaties zoals PowerBI en Excel kunnen rechtstreeks praten met de OData API en daar data uit halen voor rapportages en overzichten.
De API is ook bruikbaar voor koppelingen die de data uitwisselen met Planning.nl

Planning.nl maakt gebruik van versie 4 van de OData specificatie. 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.
Als je de pagina probeert te bekijken wordt je gevraagd om logingegevens.
Deze kan een applicatiebeheerder van Planning.nl je verstrekken.

Authenticatie

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.
Een applicatiebeheerder kan de authenticatie in en uitschakelen en je de rechten geven voor toegang tot (een deel van) de data.
Een gebruiker van de API heeft dezelfde rechten als in de webapplicatie.

Gebruik

Informatie voor het gebruik van OData (vooral voor ontwikkelaars) is vooral te vinden op odata.org.

Adressen / voorbeelden

Adres
https://app.planning.nl/OData/V1	Dit is de (base) URL van de OData API.
https://app.planning.nl/OData/V1/projects https://app.planning.nl/OData/V1/projects?$filter=Start gt 2023-01-01T00:00:00Z https://app.planning.nl/OData/V1/projects?$filter=Start gt 2023-01-01T00:00:00Z and ProjectTypeEntity/Description eq 'Maintanance'	Voorbeeld URL voor het ophalen van (alle) projecten Voorbeeld URL voor ophalen projecten die starten na 1 jan 2023 Voorbeeld URL voor ophalen projecten die starten na 1 jan 2023 en zijn van projecttype = onderhoud Let op het gebruik van hoofdletters. De OData API van Planning.nl is hoofdlettergevoelig. De juiste schrijfwijze van een veldnaaam/property en entityset (tabel) is altijd te vinden in de metadata of in het info document.
https://app.planning.nl/OData/V1/info	Informatiepagina met het overzicht van alle tabelen en velden in de OData API. In dit overzicht zijn ook de namen van de extra velden (properties) en de namen van de extra tabellen te zien als die gebruikt worden. 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) .