Nazwa

URL

Opis

Informacje o użytkowniku

/user

Szczegółowe informacje o zalogowanym uzytkowniku identyfikowanym przez paramatery token i token_secret

Zakładanie konta użytkownika

/user/create

Zdalne zakładanie konta użytkownika. Domyślnie zakładane jest próbne konto Enterprise.

Informacje o wypełnieniach na koncie użytkownika

/user/responses

Operacja zwraca informację o wypełnieniach z ostatniego tygodnia we wszystkich ankietach na koncie użytkownika.

Opis parametrów odpowiedzi

Nazwa/ścieżka

Opis

Możliwe wartości

id

ID użytkownika

email

Adres e-mail użytkownika

md5_password

Hasło skrócone funkcją md5, służące do logowania się na konto użytkownika via API

login_key

Klucz md5 służący do logowania. Konstrukcja linku logującego do panelu użytkownika to:https://www.webankieta.pl/logowanie/link/:login_key/:id,
gdzie :login_key to wartość parametry login_key a id to ID użytkownika.

registration_date

Data rejestracji konta w serwisie

activation_date

Data aktywacji konta w serwisie (potwierdzenia rejestracji)

expiration_date

Termin ważności konta – dla kont biznes i enterprise

RRRR-MM-DD dla kont biznes i enterprise

type

Rodzaj konta

biznes – konto biznes
enterprise – konto enterprise

company

Nazwa firmy

street

Adres

postal_code

Kod pocztowy

city

Miejscowość

nip

NIP

surveys_count

Liczba ankiet na koncie

id_response

ID wypełnienia używane do wypełniania wielostronicowych kwestionariuszy. Używane wspólnie z parametremrespondent_key

id_survey

ID ankiety

token

Unikalny token jednoznacznie identyfikujący respondenta. Używany do jednorazowego wypełniania ankiety przez respondenta. Parametr aktywny tylko przy najwyższym poziomie bezpieczeństwa ankiety.

date_survey_open

Data i godzina pierwszego otwarcia ankiety. Parametr aktywny tylko przy najwyższym poziomie bezpieczeństwa ankiety.

null – Ankieta nie była otwierana przez respondenta
2012-12-06 12:00:00 – Data i godzina otwarcia ankiety

date_survey_answer

Data i godzina wypełnienia ankiety. Parametr aktywny tylko przy najwyższym poziomie bezpieczeństwa ankiety.

null – Ankieta nie była wypełniana przez respondenta
2012-12-06 12:00:00 – Data i godzina otwarcia ankiety

Informacje o użytkowniku

URL

(GET) https://www.webankieta.pl/api/v2/user

Parametry

brak

Przykładowa odpowiedź

{
"email":"jan@kowalski.pl",
"md5_password":"663964500831381fc657ce86690fb0c0",
"login_key":"657ce86690fb0c0663964500831381fc",
"registration_date":"2010-01-01 00:00:00",
"activation_date":"2010-01-01 01:00:00",
"expiration_date":"2012-01-01 00:00:00",
"type":"biznes",
"company":"Moja firma",
"street":"Ulica 99",
"postal-code":"00-00",
"city":"Warszawa",
"nip":"000-000-00-00",
"surveys_count":"11"
}

Zwracane błędy

Brak

Zakładanie konta użytkownika

URL

(GET) https://www.webankieta.pl/api/v2/user/create

Parametry POST

Nazwa

Opis

email

Adres e-mail na które będzie zarejestrowane konto

firstname

Imię właściciela konta

fm_api_key

Parametr opcjnalny. Klucz do API FreshMail-a

fm_api_secret

Parametr opcjnalny. Sekretny klucz do API FreshMail-a

Przykładowa odpowiedź

{
"id":"1234",
"email":"jan@kowalski.pl",
"md5_password":"663964500831381fc657ce86690fb0c0",
"login_key":"657ce86690fb0c0663964500831381fc",
"type":"biznes"
}

Zwracane błędy

  • 400 Bad request – Nieprawidłowy adres e-mail lub adres e-mail posiada już konto w serwisie.

  • 406 Not Acceptable – Nie przekazano parametru :email.

  • 500 Internal Server Error – Wewnętrzny błąd serwera.

Informacje o wypełnieniach na koncie użytkownika

URL

(GET) https://www.webankieta.pl/api/v2/user/responses

Parametry opcjonalne (POST)

Nazwa

Opis

title

Tytuł ankiety

date_survey_open_lower

Minimalna data rozpoczęcia wypełniania ankiety. Data musi być przekazana w formacieYYYY-MM-DD (np. 2011-11-20). Po przekazaniu parametru zostaną zwrócone wypełnienia z tego dnia i dni późniejszych.

date_survey_open_upper

Maksymalna data rozpoczęcia wypełniania ankiety. Data musi być przekazana w formacieYYYY-MM-DD (np. 2011-11-20). Po przekazaniu parametru zostaną zwrócone wypełnienia z tego dnia i dni wcześniejszych.

external_key

Wartość przekazana do ankiety jako paramter external_key. Dzięki temu można wylistować wszystkie wypełnienia z danego źródła. Więcej informacji nt. external_ey można znaleźć tutaj

sm_client_id

Wartość przekazana do ankiety w przypadku włączonej integracji z Sales Manago Dzięki temu można wylistować wszystkie wypełnienia dla danego profilu.

limit

Limit na liczbę rekordów

offset

Offset na rekordów

Przykładowa odpowiedź

[
{
"id_response":123,
"id_survey":123,
"token":"2a5089",
"user_token":"ola1983",
"date_survey_open":"2012-12-06 12:00:00",
"date_survey_answer":"2012-12-06 12:00:00"
}
]

Zwracane błędy

Brak

Czy udało Ci się znaleźć odpowiedź na swoje pytanie?