Na het aanmaken van de API-key kun je de API-calls instellen. Je kunt met een call bijvoorbeeld deelnemers toevoegen aan de Community, deelnemers uitschrijven of achtergrond informatie van een Community deelnemer updaten.
Op deze pagina:
API-call instellen voor developers
API-call instellen voor developers
Op de overzichtspagina van de API vind je een overzicht van de beschikbare API-calls. Na het kiezen van de call kan een developer/IT'er van jouw organisatie met de volgende informatie de call van de API instellen:
- Kies op de overzichtspagina welke API-call je wilt gebruiken.
- Voeg de API-url toe aan connect.crowdtech.com. Zo krijg je bijvoorbeeld connect.crowdtech.com/api/v1/survey/surveys.
- Plaats de API-key in de header van de call 'X-API-key'.
Overzicht van beschikbare API-calls
Voor Community kun je voor verschillende onderdelen API-calls instellen, namelijk:
- Profielen
- Profielvariabelen
- Bouncers
Profielen
- GET /profiles: ophalen van de profielen in een lijst
- POST /profiles: het toevoegen van een of meerdere nieuwe profielen/deelnemers
- PATCH /profiles: update de informatie van een of meerdere profielen in de Community
- DELETE /profiles: een of meerdere profielen verwijderen uit de Community. Let op, dit verwijderd alle data van deze respondent
- GET /profiles /profileID: ophalen van een profiel
- PATCH /profiles /unsubscribe: schrijft profielen uit van de Community. Zij kunnen hierna niet meer benaderd worden
Profielvariabelen
- GET /variables: ophalen van de bestaande profielvariabelen en de variabeleopties van deze Community
- POST /variables: het toevoegen van een of meerdere nieuwe profielvariabelen en variabele opties aan deze Community
- PATCH /variables: het updaten van bestaande profielvariabele en de variabele opties in deze Community
- DELETE /variables: verwijderen van een of meerdere profielvariabelen of variabele opties uit deze Community
Bouncers
- GET /bouncers: ophalen van bouncers van een onderzoek.