Detail informatie API

Filtering:

Wij hebben onze filter opties recentelijk gerefactored (beta). Om die reden is dat ook nog niet opgenomen in onze documentatie.

Een voorbeeld van de opzet:
?filter=<veld>:<operator>:<waarde eventueel met quotes>,or,<veld>:<operator>:<waarde eventueel met quotes>

Voorbeelden van operators zijn:
* eq
* gt
* gte
* lt
* lte
* not:eq

API Token

Naast de Oauth 2.0 authenticatie, is het ook mogelijk een authenticatie te maken door middel van een API-key binnen je vPlan omgeving te generen. Deze manier is simpeler en minder complex. Lees hier meer over API-Key: https://support.vplan.nl/hc/nl/articles/360022631652-API-Key

Voorbeeld ophalen Collecties:

GET /v1/collection HTTP/1.1

Headers

X-Api-Key: 1UBCKBFqXhHIuYKrexwoBDRPOfD1TVHxiCWuM8pSE4sjAazW3xbv19ycLhFRoepB

X-Api-Env: e45c6167e427072e74f1c5ca80c5d8ea8f32d1a8

Voorbeeld aanmaak Collectie:

POST /v1/collection HTTP/1.1

Headers:

Content-Type: application/json;charset=UTF-8

X-Api-Key: bukpZdA70tXYa1hlI3MOQWjLM32FVdRyOFKQD7datSPvZclbCWzIDIEFElmFDG6Y

X-Api-Env: 6e9b045da9c3cc74b88ec1e4e73c926ca281c5cc

Body:

{

"name":"dit is een test2”,

"meta":["relation","123","pppp",456,"aaa",{"ccc":"bbb”}]

}

Vrije velden:

Het is mogelijk om via de API Custom Fields aan te maken/up te daten. 

De PUT en POST zijn momenteel inderdaad nog niet gedocumenteerd. Deze zullen binnenkort beschikbaar zijn.
Wel zijn deze alvast te gebruiken:

De PUT is te vinden op: https://api.vplan.nl/v1/collection/{collection_id}
De POST is te vinden op: https://api.vplan.nl/v1/collection/{collection}
Zie bijvoorbeeld onderstaand voorbeeld:

{
    "custom_fields":[
        {
            "name":"Vrij veld",
            "type":"text",
            "priority":0,
            "value":"waarde"
        }
    ]
}

Collectie + Includes + Filters

Bij de Collection zijn er een aantal include opties namelijk:
* activities
* attachments
* cards
* comments
* labels
* source

Waarbij de laatste het bron object bedoeld wordt, welke de Order zelf is, dus niet altijd relevant.

Het is mogelijk om vanuit het order endpoint deze te gebruiken, door in de include een punt "." te gebruiken tussen de objecten.
Bijvoorbeeld:
GET https://api.vplan.nl/v1/order?filter=external_ref:eq:123456&include=collection.activities,collection.labels,orderRows.activity

Op deze manier haal je de Order op, met de daarbij behorende Collectie, van die Collectie de eventueel daarbij behorende Activiteiten en Labels.
En vervolgens haal je ook alle Order Regels op met de eventueel daarbij behorende Activiteit.

Let wel dat er bij ons een aantal processen asynchroon verlopen, als je dus de Order en de Order Regels aanmaakt.
En een fractie van een seconde later de collectie ophaalt, dan is de kans aanwezig dat de Collectie nog niet helemaal bijgewerkt is.