De Mach3Forms API is een REST-API waarmee je vragenlijsten, deelnemers, antwoorden, blacklist-regels en gebruikers kunt opvragen of (in beperkte mate) aanmaken vanuit een ander systeem. Alle endpoints staan onder de prefix /api/v1/.
Voor wie?
De API is bedoeld voor ontwikkelaars die een koppeling met Mach3Forms bouwen - bijvoorbeeld om deelnemers automatisch vanuit een CRM aan te leveren, antwoorden naar een datawarehouse te kopiëren, of een eigen rapportage te bouwen.
Authenticatie
Authenticatie verloopt via een persoonlijk toegangstoken, gegenereerd via Mijn profiel → API. Stuur dit token mee als Bearer-token in de Authorization-header van elke request.
Tokens horen bij één gebruiker en hebben dezelfde rechten als die gebruiker. Gebruik bij voorkeur een aparte service-gebruiker (een gebruiker die alleen voor integraties bestaat) zodat tokens losstaan van persoonlijke accounts.
Basis-URL
De basis-URL hangt af van je omgeving:
- Standaard:
https://app.mach3forms.com/api/v1/ - Private Label:
https://<jouw-subdomein>/api/v1/
Vervang <jouw-subdomein> door het domein dat in je Private Label staat ingesteld.
Response-formaat
Alle endpoints geven JSON terug. Lijst-endpoints leveren standaard een data-array; detail-endpoints leveren een enkel data-object. Bij geslaagde requests is de status 200 OK (of 201 Created bij nieuw aangemaakte resources). Bij fouten krijg je een 4xx- of 5xx-status met een JSON-body die de fout beschrijft.
Includes en filters
Veel endpoints ondersteunen includes om gerelateerde data in dezelfde response mee te krijgen. Een include geef je mee als query-parameter:
GET /api/v1/surveys/123?include=groups.questions.options
Sommige endpoints ondersteunen ook filters:
GET /api/v1/surveys?filter[name]=feedback&filter[private]=1\
Welke includes en filters per endpoint mogelijk zijn, staat in het artikel van die endpoint.