Hoe gebruik je de API van organisaties?

Toegevoegd op maandag 11 december 2023 20:51
154

Dit artikel legt uit hoe je onze REST API kunt gebruiken om organisaties op te halen, te bewerken of toe te voegen.

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 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/organisations

Organisaties 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 alle actieve organisaties op. Gebruik een limiet van 10 objecten:

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

Organisaties 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 wilt bewerken als een JSON-array in de body van het verzoek.

Voorbeeld: update de organisatie met ID 231, voeg een korte notitie toe':

URL:

https://{bedrijfsdomein}.neoforce.app/api/v1/organisations/?filter[id]=231

BODY:

{
  "shortNotes": "Dit is een korte notitie"
}

Organisaties 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 Cyber4Z Solutions BV toe
URL:

https://{bedrijfsdomein}.neoforce.app/api/v1/organisations

BODY:

{
  "name": "Cyber4Z Solutions BV",
    "cocNr": "77736761",
    "vatNr": "NL861.117.359.B01",
    "ibanNr": "NL64 SNSB 0320 1471 18",
    "website": "https://neoforce.app",
  "email": "support@neoforce.app",
    "telephone": "085 - 487 40 90",
    "has_visitingAddress": "1",
    "address": "Kloosterweg 1",
    "zipcode": "6412CN",
    "city": "Heerlen",
    "country": "nl"
}

Het gebruik van landcodes

Landen worden op basis van de 2-letterige ISO 3166-1-norm gekozen.

Zie ook: https://nl.wikipedia.org/wiki/ISO_3166-1

Inhoudsopgave