API voorstel

Voorstel API

Hieronder een voorstel voor het opbouwen van de API

POST
/clients/customers

Parameters

key
type
example
description
client_id
int
938347
een ID waarmee we de klant kunnen indentifieren
fields
string
name,email,saldo
een kommagescheide string waarmee aangegeven kan worden welke specifieke velden er terug gegeven moeten worden. Bij leeg: alle velden
filter
array
{ "name": { "search": "Dimar", "type": "exact" } }
een array waarmee een zoekopdracht gegeven kan worden:

Key: SearchField
Type: exaxt / like
Search: SearchValue
limit
int
10
limit aan het aantal resultaten
page
int
1
wanneer limitatie is gegeven, de pagina van de resulaten

Result

key
type
example
description
results
int
43
aantal resultaten
current_page
int
2
huidige pagina van de resultaten
total_pages
int
10
totaal aantal pagina's
results
array
[ { "id": "123123", "voornaam": "Dimar", "achternaam": "van Overdijk", "email": "Dimar@themindoffice.nl" }, { "id": "5232", "voornaam": "Martijn", "achternaam": "Weerheim", "email": "Martjn@themindoffice.nl" } ]
array met alle opgevraagde klanten
PUT
/clients/customers/{customer_id}
Het kunnen updaten van eindklanten. (ivm afmeldingen nieuwsbrief e.d.)

Parameters

key
type
example
description
fields
array
{ "key": "voornaam", "value": "James" }
Een array met de velden die geupdate moeten worden

Result

key
type
example
description
status
boolean
true
is het gelukt?