Aicquisition API
v2.0.2.1Basisadres
Live: https://aicquisitioncrm.nl/api/v2
Aanvullende informatie
OpenAPI-bestand (voor Postman of Make)Proberen met een testsleutel
Dit is de documentatie van de Aicquisition API. De API werkt volgens REST: elke soort gegevens (organisatie, campagnes, lijsten, leads, gesprekken, afspraken) heeft een eigen adres, en wat je ermee doet volgt uit de methode: GET om op te vragen, POST om aan te maken, PATCH om bij te werken.
Verzoeken en antwoorden zijn JSON. Tijdstippen staan in ISO 8601 met tijdzone, bedragen in centen exclusief btw. Lijsten komen in bladzijden; zie Bladeren.
Ondersteuning
Vragen over de API, of hulp bij een koppeling? Stel je vraag via de supportpagina of mail ons. Een koppeling door ons laten bouwen kan ook.
Headers
| Header | Waarde |
|---|---|
Authorization |
|
Content-Type |
|
Accept |
|
Een sleutel aanmaken
Een sleutel maak je in Aicquisition bij Instellingen → Koppelingen. Je kiest wat hij mag (aanleveren, lezen, wijzigen) en of het een testsleutel is. Hij wordt één keer getoond en verloopt niet; intrekken kan op dezelfde plek. Zie Sleutels en rechten.
Foutmeldingen
Bij elk endpoint staat welke foutmeldingen er kunnen komen. In het algemeen:
| Status | Betekenis |
|---|---|
| 400Ongeldig verzoek | Een veld klopt niet. Het antwoord heeft een |
| 401Geen toegang | Geen sleutel meegestuurd, of een sleutel die niet (meer) werkt. |
| 403Niet toegestaan | De sleutel mist het recht voor dit endpoint; zie Sleutels en rechten. |
| 404Niet gevonden | Het adres bestaat niet, of de id hoort niet bij de werkruimte van de sleutel. Controleer of de ids bij elkaar horen. |
| 409Bestaat al | Bijvoorbeeld een lijst met dezelfde naam in de campagne. |
| 429Te veel verzoeken | Meer dan 60 verzoeken per minuut met deze sleutel. Wacht een minuut ( |
| 5xxServerfout | Aan onze kant ging iets mis. We krijgen er een melding van; blijft het gebeuren, laat ons dan weten hoe we het kunnen nadoen. |