FiberToken
Zwiększ bezpieczeństwo swoich użytkowników dzięki autoryzacji operacji w dedykowanej aplikacji mobilnej
Informacje ogólne
Głównym zastosowaniem API jest zatwierdzanie utworzonych zleceń za pomocą zewnętrznego urządzenia zgodnie z wymaganiami autoryzacji dwuskładnikowej. API obsługuje komunikację pomiędzy usługą a urządeniem na którym dokonywana jest autoryzacja.
Klucze API
Do korzystania z API konieczne jest wygenerowanie kluczy:
jawnego (apiKey) - używanego do przesyłania w ramach żądań API
tajnego (secretKey) - używanego do podpisywania żądań (nigdy nie powinien by przesyłany lub ujawniany)
W celu uzyskania danych dostępowych niezbędnych do poprawnego korzystania z API należy skontaktować się bezpośrednio z usługodawcą.
Nagłówek żądania
Każde żądanie do API powinno posiadać następujący nagłówek:
Api-Key
– wygenerowany klucz jawny
Każda odpowiedź API oraz żądanie zwrotne (callback) również posiada wskazany nagłówek.
Ciało żądania
Ciało (body) każdego żądania HTTP powinno być kodowane jako token JWT z użyciem klucza tajnego (secret) jako sygnatury.
Informacje jak odkodować lub jakich bibliotek użyć do obsługi tokenu JWT są pod adresem: https://jwt.io/
W przypadku niepoprawnego wykorzystania kluczy dostępowych serwer zwraca następujące błędy:
STATUS 400 Bad Request
Mechanizm callbacków
FiberToken posiada mechanizm tzw. callbacków. Po zmianie statusu autoryzacji (Accept/Decline) lub w przypadku modyfikacji urządzenia system wywołuje żądanie HTTP (metoda POST) na wskazany uprzednio adres (callbackUrl), gdzie:
w ciele (body) żądania zawarty jest token JWT z zaszyfrowanymi (opis powyżej) aktualnymi danymi zlecenia (payload),
w nagłówku Api-Key żądania zawarty jest jawny klucz API
Przykładowy callback po odszyfrowaniu:
Opis usług
POST /devices
Utworzenie nowego urządzenia autorazacyjnego. Parametry żądania:
Przykładowe odpowiedzi serwera:
STATUS 200 OK
W odpowiedzi serwera otrzymujemy kod (data.code) niezbędny do wykonania kolejnych żądań. Kod (pair.code) to identyfikator parowania, natomiast (pair.pairing_code) jest kodem który należy podać na urządzeniu w celu zatwierdzenia parowania.
STATUS 400 Bad Request
POST /devices/pair/renew
Odnowienie parowania urządzenia. Parametry żądania:
STATUS 200 OK
STATUS 404 Not Found
POST /devices/{code}/auth
Utworzenie zlecenia do autoryzacji. W miejscu {code} należy podać kod identyfikacyjny urządzenia na który ma zostać wysłane zapytanie. Parametry żądania:
STATUS 201 CREATED
STATUS 400 Bad Request
STATUS 404 Not Found
Last updated