SurveyLab umożliwia dostęp do Twoich ankiet i danych za pomocą REST API. Dostęp do API odbywa się za pomocą szyfrowanego połączenia (SSL / HTTPS) oraz tokenu. Dane są udostępniane w formacie JSON. Autoryzacja użytkownika odbywa się za pomocą JWT.
UWAGI. Aby skorzystać z API będziesz potrzebować clientId oraz clientSecret. Te informacje są udostępniane na żądanie. Skontaktuj się z nami, aby je uzyskać.
Lista dostępnych zapytań:
Statusy są zwracane za pomocą standardowych kodów błędów HTTPS.
Kod | Opis |
---|---|
200 | OK. Zapytania zostało wykonane pomyślnie. |
400 | Bad request. Zapytanie nie powiodło się. Błędny token. |
401 | Unauthorized. Prubujesz zautoryzować się za pomocą błędnego loginu lub klucza API. |
404 | Not Found. Zasób nie istnieje. |
500 | Internal Server Error. Spróbuj ponownie lub skontaktuj się z naszym wsparciem. |
Pobranie tokena do bezpiecznej komunikacji. Token jest ważny przez 30 dni.
POST https://api.surveylab.com/oauth/token/
cURL
curl -i -X POST https://api.surveylab.com/oauth/token/ -d "clientSecret=YOUR_CLIENT_SECRET &clientId=YOUR_CLIENT_ID"
Przykład wyniku zapytania
Pobranie listy ankiet. Otrzymasz listę wszystkich ankiet znajdujących się na Twoim koncie.
GET https://api.surveylab.com/api/v2/surveys/
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/
Przykład wyniku zapytania
Pobranie pojedynczej ankiety. Otrzymasz całą ankietę, w tym informację o stronach, blokach, ... Aby wykonać zapytanie będziesz potrzebował numer id ankiety. Możesz go znaleźć na stronie podglądu lub stronie projektu ankiety.
GET https://api.surveylab.com/api/v2/surveys/:id/
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/
Przykład
GET https://api.surveylab.com/api/v2/surveys/21045/
Przykład wyniku zapytania
Pobranie listy pytań dla wybranej ankiety. Otrzymasz tylko pytania.
GET https://api.surveylab.com/api/v2/surveys/:id/questions/
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/questions/
Przykład wyniku zapytania
Pobranie listy odpowiedzi, pierwsze 100 wpisów.
GET https://api.surveylab.com/api/v2/surveys/:id/responses
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses
Przykład
GET https://api.surveylab.com/api/v2/surveys/21045/responses
Przykład wyniku zapytania
Pobranie listy odpowiedzi, kolejne 100 wpisów. Zmień numer strony (np. /page/2/), aby pobrać kolejne 100 rekordów. Możesz ustawić sortowanie: asc (rosnąco) lub desc (malejąco).
GET https://api.surveylab.com/api/v2/surveys/:id/page/2/responses
GET https://api.surveylab.com/api/v2/surveys/:id/page/2/order/asc/responses/
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/page/2/responses
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/page/1/order/asc/responses/
Example
GET https://api.surveylab.com/api/v2/surveys/21045/page/2/responses
GET https://api.surveylab.com/api/v2/surveys/21045/page/2/order/asc/responses/
Result example
Pobranie pojedynczej odpowiedzi dla wybranej ankiety. Możesz użyć zamiennie response-id lub crk.
GET https://api.surveylab.com/api/v2/surveys/:id/responses/:response-id
GET https://api.surveylab.com/api/v2/surveys/:id/crk/:crk
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses/:response-id
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/crk/:crk
Example
GET http://api.surveylab.com/api/v2/surveys/27162/responses/7423534
GET http://api.surveylab.com/api/v2/surveys/27162/crk/AGVIDd43
Pobieranie metadanych, takich jak system operacyjny, przeglądarka, język czy rodzaj urządzenia.
cURL
curl -i -X GET -H "Authorization:bearer YOUR_ACCESS_TOKEN" -H "Content-Type": "application/json" https://api.surveylab.com/api/v2/surveys/:id/responses/:responseId/metadata/
Example
GET https://api.surveylab.com/api/v2/surveys/27162/responses/7423534/metadata/
Przykład wyniku zapytania
Stale udoskonalamy nasze oprogramowanie oraz API. Jeśli masz pytania lub potrzeby dotyczące API skontaktuj się z nami.
UWAGI. REST oznacza REpresentational State Transfer. API oznacza Application Programming Interface. JSON oznacza JavaScript Object Notation. JWT oznacza JSON Web Token.
Funkcjonalność dostępna jest dla kont Enterprise.
Powiązane strony