Punkt dostępowy

Punkt dostępowy API znajduje się pod adresem:

https://api.lumo.pl

Należy zwrócić uwagę, że dostęp odbywa się szyfrowanym połączeniem HTTPS.

Uwierzytelnianie

Dane dostępowe

Klucze dostępu (client_id, client_secret) do API można wygenerować po zalogowaniu do aplikacji WWW korzystając z ustawień i modułu API.

Nie należy upubliczniać klucza client_secret.

Pobieranie tokena

W celu pobrania tokena należy wykonać zapytanie podając parametry:

  • grant_type=password
  • client_id UID aplikacji
  • client_secret sekret aplikacji
  • login login (e-mail lub numer telefonu) do konta Lumo
  • password hasło do konta Lumo
curl -F grant_type=password -F client_id=123 -F client_secret=XYZ -F login=user@example.com -F password=pass1234 -X POST https://api.lumo.test:4000/oauth/token
Odświeżanie tokena

Ważność tokena to 24 godziny. W celu odświeżenia tokena należy wykonać zapytanie podając parametry:

  • grant_type=refresh_token
  • refresh_token przeterminowany token
  • curl -F grant_type=refresh_token -F refresh_token=XYZ -X POST https://api.lumo.test:4000/oauth/token
Testowanie tokena

W celu przetestowania tokena można ustawić nagłówek Authorization Bearer

curl -H "Authorization: Bearer XYZ" -X GET https://api.lumo.pl/me

lub jako parametr access_token lub bearer_token

curl -X GET https://api.lumo.pl/me?access_token=XYZ

Stronicowanie

Zapytania o kolekcje (listę) zasobów zwracają ograniczoną ilość danych i są stronicowane.

W celu pobrania kolejnych wyników należy użyć parametru page, zaś w większej ilości danych per_page.

curl -H "Authorization: Bearer XYZ" -X GET https://api.lumo.pl/prizes?page=2&per_page=50

Sortowanie

Zapytania o kolekcje (listę) zasobów zwracają przeważnie dane posortowane o datę utworzenia.

W celu posortowania wyników należy użyć parametru order, oraz dla kolejności (malejąco lub rosnąco) order_direction.

curl -H "Authorization: Bearer XYZ" -X GET https://api.lumo.pl/prizes?order=name&order_direction=DESC

Wyszukiwanie

Zapytania o kolekcje (listę) zasobów mogą być przeszukiwane.

W celu filtrowania wyników należy użyć parametru q.

curl -H "Authorization: Bearer XYZ" -X GET https://api.lumo.pl/prizes?q=Foo

Kody odpowiedzi

  • 200 Poprawnie wykonane zapytanie

  • 201 Zasób poprawnie utworzony

  • 204 Zasób poprawnie zaktualizowany lub usunięty

  • 401 Brak autoryzacji lub uprawnień do danego zasobu

  • 404 Zasób nie odnaleziony

  • 422 Problem z zasobem wraz z informacją o błędach

  • 500 Błąd po stronie serwera

Zasób Opis
Firmy Firmy w platformie Lumo
Komentarze do opinii Komentarze do opinii klientów
Grupy klientów Grupy klientów
Pochodzenie klientów Rodzaje pochodzenia klientów
Klienci Klienci wykorzystywani w transakcjach
Nagradzanie za polecenie Transakcje związane z poleceniami klientów
Polecenia klientów System poleceń klientów
Usługi i produkty Usługi i produkty wykorzystywane w transakcjach
Kategorie nagród Kategorie nagród
Przyznawanie nagród Transakcje związane z przyznawaniem nagród
Nagrody Nagrody dostępne dla uczestników
Nagradzanie publikacji opinii Transakcje związane z przyznawaniem punktów za publikację komentarza
Publikacje opinii Publikacje opinii klientów w serwisach
Nagradzanie opinii Transakcje związane z przyznawaniem punktów za napisanie komentarza
Opinie Opinie klientów
Ustawienia Ustawienia danej firmy
Typy transakcji Typy transakcji dostępne na platformie Lumo
Transakcje Transakcje zakupowe klientów
Konto użytkownika Profil i dane dostępowe użytkownika