Aan de slag

Het integreren van Survio met uw interne systemen kan worden gedaan via API. Hier is een korte handleiding om u op weg te helpen.

 

Let op: API toegang is alleen beschikbaar voor Survio PRO klanten.




Survio biedt een API om automatisch gegevens op te halen uit verschillende bronnen. Deze gegevens kunnen worden gebruikt voor verdere analyse of procesimplementatie. Bijvoorbeeld, u kunt klanten een tevredenheidsonderzoek sturen en Survio automatisch hun antwoorden laten doorsturen naar uw CRM of een BI-tool om de gegevens verder te volgen en te evalueren. Dit geeft het management de mogelijkheid om snel en correct te handelen of consequent op lange termijn te plannen.

 

De Survio API volgt de Open API standaard en dit schema is ook beschikbaar om te downloaden. 

 

Bronnen

Momenteel biedt de API toegang tot één bron - individuele antwoorden.,


Gebruik van API's

De API-aanvraag gaat via HTTP naar de host "https://api2.survio.com/v2/". Om de gegevens te lezen, moet u echter inloggegevens verkrijgen.

 

Om aanvragen uit te voeren is autorisatie nodig, wat gebeurt via een API-token. Het token wordt verzonden in een HTTP-header. Het formaat van dit headertype is als volgt:

 

Authorization: Bearer <token>

 

Een voorbeeld van een aanvraag om antwoorden te krijgen ziet er dan als volgt uit:

 

Example request

 

Het token wordt specifiek voor uw account gegenereerd, zodat u alleen toegang hebt tot gegevens binnen uw account. Het token heeft geen vervaldatum, maar kan op aanvraag worden geannuleerd.

 

Om een token te genereren kunt u contact opnemen met onze klantenservice. 

 

Iedereen met het token heeft toegang tot uw accountgegevens via API in een read-only modus. Hoewel het niet mogelijk is de gegevens te verwijderen of anderszins te beschadigen, raden wij u aan het token veilig te bewaren om misbruik te voorkomen. Het is mogelijk om het huidige token op elk moment te deactiveren en eventueel een gloednieuw token te genereren.

 

Meer gedetailleerde informatie over de API vindt u in de referentie.

 

Elke bron bevat een URL, een aanvraagmethode, een aanvraagschema en een antwoordschema.

 

Paginering en filters

Elke bron die een lijst van records bevat, geeft maximaal 30 resultaten per aanvraag. De resultaten worden gesorteerd in aflopende volgorde vanaf het meest recente record. Als er meer dan 30 resultaten zijn, kunt u de GET-parameter gebruiken:

 

?page=<page number>

 

om elke pagina van de volgende resultaten weer te geven.

De paginanummering begint met het cijfer "0":

 

“?page=0” toont de eerste pagina, 
“?page=1” toont de tweede pagina, 
“?page=2” toont de derde pagina, enz. totdat de aanvraag geen resultaat oplevert.

 

Bij elke bron kunnen ook verschillende filters worden toegepast om de resultaten te specificeren. U kunt kiezen uit

  • datum → filtert resultaten op een specifieke datum

  • van - tot → filtert resultaten op een bepaald tijdsinterval

  • voltooiingstijd → filtert de resultaten op de hoeveelheid tijd die nodig is om de enquête te voltooien

U kunt bijvoorbeeld een record krijgen van antwoorden die na een bepaalde datum zijn ontvangen met de volgende opmaak:


?submitted[after]=<time>

 

Het is ook mogelijk om filters te koppelen en bijvoorbeeld een specifiek tijdsinterval in te stellen:

 

?submitted[after]=<time>&submitted[before]=<time>

 

Limieten voor oproepen

Het belangrijkste doel van oproeplimieten is te zorgen voor een betrouwbare werking van de API, constante beschikbaarheid van gegevens en voorkoming van misbruik van gegevens, zodat u op elk moment over alle benodigde informatie beschikt. Deze limieten gelden alleen voor een hoeveelheid van 1.000 HTTP-verzoeken per uur per gebruiker.

 

Hebt u feedback voor ons?

Om de gebruikerservaring te verbeteren bij het gebruik van API-integratie in Survio, zouden we uw feedback op prijs stellen. Als u een fout of een niet-werkende functie ontdekt, neem dan gerust contact met ons op.