Na het aanmaken van de API-key kun je de API-calls instellen. Je kunt met een call bijvoorbeeld deelnemers toevoegen aan een onderzoek, resultaten ophalen of bijvoorbeeld uitgeschreven e-mailadressen verwerken.
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 Survey kun je voor verschillende onderdelen API-calls instellen, namelijk:
- Surveys: ophalen van een compleet overzicht of een specifieke onderzoek;
- Survey-resultaten; alle resultaten van een onderzoek;
- Respondenten: toevoegen of ophalen van respondenten;
- Survey-vertalingen: vraag- en antwoordteksten van meertalig onderzoeken;
- Bouncers;
- Uitschrijvers;
- Dataverrijking.
Surveys
- GET /surveys: een overzicht van de huidige onderzoeken in het account en hun instellingen.
- GET /surveyId: instellingen van een onderzoek en de statistieken met betrekking tot de deelname.
Survey-resultaten
- GET /results: ophalen van de geaggregeerde data van een onderzoek.
Survey-vertalingen
- GET /gettranslation: overzicht van de vraag- en antwoordteksten. Als je een meertalig onderzoek hebt zie de bronteksten (sourcetext) en de vertalingen (text).
Respondenten
- GET /respondents
- GET /respondentId: respondenten van een onderzoek ophalen;
- POST /respondents: respondenten aan een onderzoek toevoegen;
- PATCH /enrichment: dataverrijking updaten in een onderzoek;
- PATCH /respondents/unsubscribe: toevoegen van uitschrijvers voor alle Surveys in een omgeving;
- PATCH /respondentId/unsubscribe: toevoegen van een uitschrijver toevoegen.
Bouncers
- GET /bouncers: ophalen van bouncers van een onderzoek.
Uitschrijvers
- GET /unsubscribes: lijst van uitgeschreven respondenten;
- PATCH /: schrijf respondenten uit voor alle surveys.
Dataverrijking
- PUT / vervang dataverrijking in het onderzoek. Dit is alleen mogelijk als er nog geen completes zijn.
Gebruikers die kunnen inloggen in Surveyplatform
- GET/ users: lijst van gebruikers ophalen die kunnen inloggen via SSO;
- POST/ users: gebruikers die kunnen inloggen via SSO toevoegen aan een account;
- PATCH/ gebruikers die kunnen inloggen via SSO updaten;
- DELETE/ users: gebruikers die kunnen inloggen via SSO verwijderen;
- GET/ userid: gebruiker ophalen die kan inloggen via SSO.
SCIM 2.0: SCIM is een internationale standaard voor het automatisch beheren van rollen en rechten.
- GET/ groups: een lijst ophalen van alle bestaande rollen;
- POST/ groups: een nieuwe rol aanmaken;
- PATCH/ groups: een rol updaten;
- DELETE/ groups: een rol verwijderen;
- GET/ schemas: ophalen van omschrijving hoe SCIM 2.0 wordt ingezet in de API;
- GET/ users: ophalen van alle users die kunnen inloggen via SSO;
- POST/ users: gebruikers toevoegen aan SSO;
- GET/ usersid: ophalen van 1 user;
- PATCH/ userid: update een gebruiker;
- DELETE/ user: verwijder een gebruiker;