Introductie REST-API

Ontdek de documentatie van de REST-API van het WAVEDESK-platform.

De handleiding is onderverdeeld in de volgende secties:

🔓Authenticatie

Hier vindt u een samenvatting van het authenticatieproces vereist voor het maken van oproepen naar de REST-API.

Hieronder vindt u een samenvatting van de beschikbare eindpunten. Om de structuur helder te houden, xijn de API-eindpunten per module gegroepeerd.

📘Modules

Ondersteuning RQL

Bepaalde eindpunten bevatten ondersteuning voor RQL die u toelaat om bepaalde parameters mee te geven om het resultaat te beperken of de volgorde aan te passen. Eindpunten die ondersteuning bieden voor RQL hebben de vermelding voor de ondersteuning in de introductie van het eindpunt.

Werking RQL

RQL laat u toe om extra parameters mee te geven aan het eindpunt. Dit kan u doen door het eindpunt te laten volgen door het volgende formaat: ?rql=RQL-commando

Voorbeeld

Deze call: https://wavedesk.cloud/frames/v1/crm/accounts?rql=contains(addresspostalcode,9130) zal bijvoorbeeld de relaties ophalen waarvan de postcode van het adres gelijk is aan 9130.

Beschikbare operatoren

Hieronder kan u een overzicht terugvinden van de verschillende operatoren die worden ondersteund:

eq(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap gelijk is aan de opgegeven waarde

lt(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap kleiner is dan de opgegeven waarde

le(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap kleiner is dan of gelijk is aan de opgegeven waarde

gt(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap groter is dan de opgegeven waarde

ge(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap groter is dan of gelijk is aan de opgegeven waarde

ne(,) Filtert op objecten waarbij de waarde van de opgegeven eigenschap niet gelijk is aan de opgegeven waarde

and(,,...) Past alle opgegeven zoekopdrachten toe

or(,,...) De vereniging van de opgegeven query's

sort(< +|- ><eigenschap) Sorteert op de opgegeven eigenschap in de volgorde gespecificeerd door het voorvoegsel (+ voor oplopend, - voor aflopend)

limit(count,start,maxCount) Retourneert het opgegeven bereik van objecten uit de resultatenset

contains(,<value | expression>) Filtert op objecten waarbij de waarde van de opgegeven eigenschap een array is en de array een waarde bevat die gelijk is aan de opgegeven waarde of voldoet aan de opgegeven expressie

in(,) Filtert op objecten waarvan de waarde van de opgegeven eigenschap zich in de opgegeven array bevindt

out(,) Filtert op objecten waarvan de waarde van de opgegeven eigenschap niet in de opgegeven array voorkomt