Wszystkie kolekcje
API dokumentacja
oAuth API
Ogólne informacje o Webankieta API
Ogólne informacje o Webankieta API
Piotr Sadowski avatar
Napisane przez Piotr Sadowski
Zaktualizowano ponad tydzień temu

Webankieta API umożliwia dostęp do zasobów serwisu Webankieta.pl za pomocą interfejsu JSON. Dzięki temu możliwe staje się stworzenie zewnętrznych aplikacji integrujących się z kontem użytkownika Webankieta.pl.

Service URL

Punkt dostępowy API (URL bazowy) znajduje się pod adresem:

https://www.webankieta.pl/api/v2

Dostęp odbywa się szyfrowanym połączeniem (https://).

Jak zorganizowane jest Webankieta API

REST, REST-like

Operacje w Webankieta API są zorganizowane wg. stylu REST. Oznacza to, że adres URL identyfikuje pewien zasób, natomiast akcja jaką należy wykonać jest określana na podstawie odpowiednich segmentów URL-s oraz metody (GET, POST).

  • GET – pobranie informacji na temat zasobu lub usunięcie zasobu o podanym identyfikatorze

  • POST – stworzenie nowego lub zmiana istniejącego zasobu

Format zwracanej odpowiedzi

Webankieta API zwraca odpowiedzi w formacie – JSON.

Kodowanie

Wszystkie dane wysyłane do Webankieta API powinny być kodowane w UTF-8.

Uwierzytelnianie

Klucz oraz API Secret znajdziesz w Ustawieniach konta w zakładce Integracje.

Dodatkowo należy wygenerować token dostępu , aby móc połączyć się API.

Kody statusu/błędów

Rezultat wykonanego zapytania można określić na podstawie kodu błędu HTTP.
W Webankieta API używane są następujące kody:

  • 200 OK – Zapytanie zostało wykonane poprawnie

  • 400 Bad Request – Parametr przyjął nieprawidłową wartość lub wartość parametru nie znajduje się w określonym zbiorze.

  • 401 Unauthorized – Brak autoryzacji lub uprawnień do danego zasobu.

  • 402 Payment Required – Ograniczenia wykupionego pakietu uniemożliwiają dostęp do zasobu.

  • 404 Not Found – Zasób nie został znaleziony lub nie istnieje.

  • 406 Not Acceptable – Wymagany parametr nie został przekazany.

  • 409 Conflict – Kod zwracany przy nieudanej próbie zapisu danych (np. aktywacja ankiety).

  • 500 Internal Server Error – Kod zwracany w przypadku wystąpienia wewnętrznego błędu serwera.

Czy to odpowiedziało na twoje pytanie?