Hoe gebruik je de API van datasets?

Toegevoegd op vrijdag 18 november 2022 10:58 | Laatst gewijzigd op maandag 11 december 2023 20:14
391

Dit artikel legt uit hoe je onze REST API kunt gebruiken om gegevens te verkrijgen, bij te werken of toe te voegen met de module datasets.

✅ De Neoforce API stelt je in staat om nieuwe objecten te bekijken, toe te voegen en te bewerken.

Aan de slag

➡️ Het is belangrijk om eerst een token te verkrijgen. Controleer dit artikel om te weten te komen hoe u een token kunt krijgen.

Authenticatie van API-verzoeken gebeurt via een Bearer-token via de header van het verzoek.
Voeg daarom de volgende header toe aan elk verzoek dat u naar onze API stuurt:

X-Authorization: Bearer [token]

Endpoint-URL

Je dient een GET-, PUT- of POST-verzoek te sturen naar ten minste het volgende endpoint-adres. Afhankelijk van de gekozen methode in het http-verzoek, wordt bepaald of je wil lezen, schrijven of toevoegen.

Endpoint

https://{bedrijfsdomein}.neoforce.app/api/v1/datasets/?filter[schema]={schema-name}

Objecten ophalen van de API

Stuur een GET-verzoek naar het endpoint. Het is mogelijk om te filteren op kolommen. Voeg de filter [kolom_naam]=filter toe aan de URL. Dit zal alle objecten retourneren die overeenkomen met je filter.

Voorbeeld: haal alle inactieve laptops op uit het laptopschema. Gebruik een limiet van 10 objecten:

https://{bedrijfsdomein}.neoforce.app/api/v1/datasets/?filter[schema]=obj_laptops&filter[active]=0&limit=10

Objecten bewerken via de API

Stuur een PATCH-verzoek naar het endpoint. Het is belangrijk om een filter aan de URL toe te voegen om onnodige wijzigingen aan objecten te voorkomen. Stuur de kolommen die je wile bewerken als een JSON-array in de body van het verzoek.

Voorbeeld: update de laptop met objectID 0027 om het merk te wijzigen naar 'Apple':

URL:

https://{bedrijfsdomein}.neoforce.app/api/v1/datasets/?filter[schema]=obj_laptops&filter[objectID]=0021

BODY:

{
  "merk": "Apple",
  "type": "MacBook Pro 13 inch"
}

Objecten toevoegen via de API

Stuur een POST-verzoek naar het endpoint. Stuur de kolommen die je wil toevoegen als een JSON-array in het body van het verzoek.

Voorbeeld: Voeg een nieuwe Macbook Pro 13 inch toe aan het schema 'laptops'.
URL:

https://{bedrijfsdomein}.neoforce.app/api/v1/datasets/?filter[schema]=obj_laptops

BODY:

{
  "merk": "Apple",
  "type": "MacBook Pro 13 inch"
}

Hoe weet je de kolomnamen?

Bij het aanmaken van een nieuw veld, kent Neoforce kolomnamen toe aan het nieuwe veld. Je vindt deze naam als je een bestaand veld bewerkt via beheer.

Ga hiervoor naar Beheer > Schema's > [Kies een schema] en klik op het gewenste veld. Daar vind je het 'kenmerk' die als interne kolomnaam geldt.

image.png

Inhoudsopgave