Skip to content

Latest commit

 

History

History
243 lines (172 loc) · 13.8 KB

README.md

File metadata and controls

243 lines (172 loc) · 13.8 KB
Raw

Serwisant Online API

Wstęp

Dostęp do API mają klienci z aktywną subskrypcją all-in-one. Wygaśnięcie subskrypcji które skutkuje przejściem aplikacji w tryb 'tylko-do-odczytu' będzie, w przypadku API skutkowało całkowitą blokadą API.

API oparte jest o autoryzację OAuth oraz format GraphQL. Działa na bazie standardowego protokołu HTTPS.

GraphQL jest typowanym API, w którym używa się składni JSON do żądań a także w odpowiedziach, przy czym jest to koncepcja całkowicie odmienna od API opartego o REST.

Wsparcie

Operator oprogramowania Serwisant Online nie udziela nieodpłatnego wsparcia w zakresie architektury integracji, API, bibliotek lub implementacji. Wszystkie technologie użyte w ramach API są technologiami otwartymi, dobrze udokumentowanumi. Wsparcia należy szukać:

  • w niniejszym dokumencie w zakresie podstawowych informacji
  • w dokumentacji standardów GraphQL oraz OAuth
  • na stronach pomocy do aplikacji Serwisant Online w zakresie informacji o procesach, danych, etc.

Operator może udzielić odpłatnego wsparcia we weszystkich ww. zakresach. W celu uzywkania odpłatnego wsparcia prosimy o kontakt.

Zacznij w kilku krokach

  1. Zapoznaj się z dokumentacją znajdującą się na stronie https://graphql.org/learn
  2. Przeczytaj resztę tego dokumentu, aby pogłębić wiedzę na temat API
  3. Pobierz i zainstaluj oprogramowanie do przeglądania dokumentacji API i wykonywania zapytań. Polecamy Altair GraphQL Client
  4. Uruchom oprogramowanie i użyj jednego z adresów, podanych w sekcji "Zakres funkcjonalny, aktorzy" aby przeglądać API. Nie potrzebujesz do tego aplikacji i danych OAuth, po prostu użyj odpowiedniego adresu i zacznij przeglądać dokumentację już teraz
  5. Zarejestruj aplikację OAuth w ustawieniach Serwisant Online
  6. Użyj klienta HTTP odpowiedniego dla języka, w którym piszesz, np cUrl dla PHP lub Faraday dla Ruby aby pobrać token autoryzacyjny i wykonywać zapytania GraphQL - nie musisz używać specjalnych bibliotek OAuth lub klientów GraphQL. Aby używać API wystarczy sam klient HTTP

Jest coś więcej?

Tak, do API dodajemy dwie biblioteki, które ułatwią ci integrację, w zależności od potrzeb i technologii które stosujesz:

Ok, ale gdzie jest dokumentacja?

Przeczytaj punkt 3. we wcześniejszej sekcji. Schema API jest równocześnie jego dokumentacją - wiele zapytań, mutacji i pól ma także dodane przez nas opisy, które omawiają czym jest dany element.

Zakres funkcjonalny, aktorzy

Zgodnie z koncepcją GraphQL, podstawowym elementem API jest schema. Z uwagi na fakt, iż w ramach aplikacji Serwisant Online występują różni aktorzy (użytkownicy) udostępniliśmy kilka różnych schem, każda z nich przeznaczona jest dla innego aktora.

service

Schema service zlokalizowana jest pod adresem https://serwisant.online/graphql/service.

Aktorem w tej części API jest pracownik serwisu. Oznacza to, że znajdują się tutaj funkcjonalności, które widzisz po zalogowaniu się do aplikacji Serwisant Online jako pracownik.

Korzystaj z tej schemy, jeśli chcesz budować integracje mające dostęp i mogące modyfikować wszystkie dane w twojej bazie.

Schema co do zasady wymaga obecności konta pracownika i token OAuth użyty aby uzyskać do niej dostęp powinien być uzyskany poprzez zalogowanie. Mają tu zastosowanie wszystkie istniejące ograniczenia związane z pracownikiem, czyli limitowanie IP, nadane uprawnienia, lub blokada/usunięcie konta.

Dodatkowo, po nadaniu specjalnego uprawnienia (patrz sekcja "Autoryzacja") możesz uzyskać dostęp bez logowania jako pracownik.

Zwróć uwagę, że w tym przypadku nie będą stosowane ograniczenia, np. blokada IP, dostęp może być cofnięty wyłącznie poprzez usunięcie całej aplikacji OAuth, zaś wszystkie operacje zapisu będą logowane na konto wirtualnego pracownika System którego znajdziesz już teraz na liście pracowników.

public

Schema public, nie wymaga aktora w postaci poświadczeń konkretnej osoby. Możesz ją znaleźć pod adresem https://serwisant.online/graphql/public Przeznaczona jest do anonimowych operacji, takich jak sprawdzenie stanu naprawy, akceptacja lub odrzucenie kosztów naprawy.

Korzystaj z tej schemy, jeśli chcesz udostępnić na własnej stronie proste sprawdzanie stanu naprawy.

Schema nie wymaga obecności konta pracownika lub klienta.

customer

Schema customer dostępna jest pod adresem https://serwisant.online/graphql/customer Aktorem tutaj jest klient serwisu.

Schema ta implementuje wszystkie funkcjonalności Panelu klienckiego aplikacji i jej głownym przeznaczeniem jest samodzielna implementacja tej czesci aplikacji, wzbogacona w własną logikę oraz wygląd.

Autoryzacja

Dostęp do API autoryzowany jest za pomocą tokenu OAuth, który należy uzyskać przed pierwszym zapytaniem do API.

Przed rozpoczęciem integracji wymagane jest abyś dodał aplikację OAuth. Możesz ją utworzyć używając narzędzia ze strony: https://serwisant.online/oauth_applications

W trakcie tworzenia aplikacji otrzymasz key i secret, które posłużą do uzyskania tokenu OAuth. Musisz także określić zakres dostępu, który będzie miała aplikacja. Możesz wybrać spośród kilku uprawnień.

public - uprawnienie pozwalające aplikacji na dostęp do schemy public

customer - uprawnienie pozwalające dostęp do schemy customer w części bez zalogowania oraz z logowaniem

service_read - uprawnienie pozwalające odczytywać dane ze schemy service

service_write - uprawnienie pozwalające zapisywać dane z użyciem schemy service. Zwróć uwagę, że do zapisu wymagane jest uprawnienie do odczytu, ponieważ będziesz musiał przed zapisem określić identyfikatory relacji.

service_allow_untrusted - pozwalaj na dostęp do API bez konieczności podawania poświadczeń pracownika (login, hasło) - do autoryzacji wystarczą key i secret aplikacji OAuth. Wszelkie operacje zapisu będą robione na poczet pracownika System. Stosuj to uprawnienie z rozwagą, głównie do aplikacji, w których nie istnieje kontekst pracownika, np. dodawanie napraw z poziomu twojej strony WWW.

Token możesz uzyskiwać wykonując zapytanie HTTP POST na https://serwisant.online/oauth/token

Zapytanie powinno mieć następujące parametry, wysłane jako form-data

  • grant_type - określa sposób logowania - client_credentials to logowanie bezkontekstowe, z użyciem danych aplikacji, password to logowanie konkretnego użytkownika i praca z jego poświadczeniami.
  • client_id - identyfikator aplikacji, inaczej key podany podczas tworzenia aplikacji
  • client_secret - hasło aplikacji, inaczej secret podany podczas tworzenia aplikacji
  • scope - uprawnienia na których będzie działała aplikacja. Uprawnienia oddzielane są spacją. Możesz podać tu mniej uprawnień niż zdefiniowano dla aplikacji, lecz nie więcej - prośba o uprawnienia inne, niż te które definiuje aplikacja identyfikowana poprzez client_id nie powiedzie się.
  • username i password - login i hasło pracownika lub klienta w przypadku użycia grant_type=password - to muszą być poprawne dane konta istniejącego w ramach aplikacji.

Przykładowe zapytania:

curl 
  -X POST 
  --data "grant_type=client_credentials&client_id=<***>&client_secret=<***>&scope=public" 
  https://serwisant.online/oauth/token

curl 
  -X POST 
  --data "grant_type=client_credentials&client_id=<***>&client_secret=<***>&scope=service_read service_allow_untrusted" 
  https://serwisant.online/oauth/token

curl 
  -X POST 
  --data "grant_type=password&client_id=<***>&client_secret=<***>&username=jankowalski&password=<***>&scope=service_read service_write" 
  https://serwisant.online/oauth/token

W odpowiedzi otrzymasz JSON, w którym będzie token OAuth, a także jego TTL (czas życia) w sekundach. Po upływie TTL token nie może być dłużej wykorzystany, jego użycie zostanie potraktowane jako nieautoryzowany dostęp. Przed upływem tego czasu należy ponownie przeprowadzić operacje uzyskania tokena.

Jeśli token uzyskujesz przy pomocy loginu i hasła, to otrzymasz w odpowiedzi dodatkowo refresh_token - może on zostać użyty do ponownego pobrania access_tokena dla użytkownika bez konieczności ponownego proszenia go o hasło. Aby pobrać (odświeżyć) token użytkownika użyj przykadowego zaytania:

curl 
  -X POST 
  --data "grant_type=refresh_token&client_id=<***>&client_secret=<***>&refresh_token=<***>"
  https://serwisant.online/oauth/token

UWAGA: nie powinieneś uzyskiwać tokena przy każdym zapytaniu. Token powinien być pozyskany jeśli wcześniej nie istniał lub czas jego życia się skończył. Zastrzegamy sobie możliwość blokady aplikacji, które pozyskują token przy każdym zapytaniu.

Zapytania API

Zapytania API wysyłane są metodą POST gdzie payload przekazany jest w formie raw JSON na adres odpowiedniej schemy.

Zapytanie powinno być zgodnie ze specyfikacją GraphQL i zawierać nagłówki HTTP:

  • Authorization: Bearer 000000000000000000000 - nagłówek autoryzacji, gdzie 000000000000000000000 jest tokenem OAuth uzyskanym z osobnego adresu (patrz sekcja Autoryzacja)
  • Content-Type: application/json - określenie typu żądania

Przykładowe zapytanie:

curl
  -X POST
  -H "Content-Type: application/json"
  -H "Authorization: Bearer 000000000000000000000"   
  --data '{ "query": "{ viewer { employee { displayName } } }" }'
  https://serwisant.online/graphql/service

Przykłady wysyłania zapytań w PHP i innych językach można znaleźć w sieci, np. w artykule https://www.contentful.com/blog/2021/01/14/GraphQL-via-HTTP-in-five-ways/

Complexity

W ramach API GQL działającego na serwisant.online wdrożony jest mechanizm ochrony przed nadmierną złożonością i głębokością zapytań. Zapytania o nadmiernej złożoności zwrócą informację: Query has complexity of x, which exceeds max complexity of y gdzie x to obliczona złożoność wysłanego zapytania, zaś y to maksymalna dopuszczalna złożoność.

Głębokość zapytania, to ilość zagnieżdzeń kolejnych encji w zapytaniu.

Złożoność zapytania to obliczony dla wysłanego zapytania koszt, który:

  • dla każdego żądanego pola wynosi 1
  • dla wybranych pól, które zwracają kosztowny obliczeniowo wynik lub np wynik pobierany z zewnętrznej usługi, może wynosić od 2 do 1000
  • dla list które w parametach mają limit (domyślnie, jeśli nie jest podany, wynosi 20) jest mnożony o wartość limit

Przykładowo, zapytanie:

{
  repairs {
    items {
      ID
      rma
      customer {
        ID
      }
    }
  }
}

będzie miało głębokość 3 oraz złożoność 80, ponieważ wewnątrz items mamy 4 pola, które możone są przez domyślny limit ilości wyników, czyli 20.

Natomiast zapytanie:

{
  repairs(limit: 1) {
    items {
      ID
      rma
      customer {
        ID
      }
    }
  }
}

będzie miało nadal głębokość 3, przy czym złożoność wyniesie 4, ponieważ nadal mamy 4 pola, ale stosujemy ograniczenie 1 wyniku.

Mając na uwadze powyższe, należy stosować się do następujących zaleceń:

  • nie dodawać do zapytań żadnych nadmiarowych pól, które nie będą w rzeczywistości konsumowane - dotyczy to szczególnie list elementów
  • kompleksowe zapytania, z dużą ilością pól, powinny dotyczyć indywidualnych elementów (mieć filter: ID) i zawsze mieć ograniczenie do 1 rekordu, niezależnie od tego, ile w rzeczywistości zwracają wyników.

Przykładowe procesy

API udostępnia składowe elementy potrzebne do przeprowadzenia procesu (operacji) ale nie implementuje caych procesów. W dużej ilości przypadków, aby wykonać jakąś operację, należy wykorzystać więcej elementów API, np zapytań lub innych mutacji, np. aby przeprowadzić pewne operacje zapisu, wymagane jest uprzednie pozyskanie identyfikatorów relacji które są wymagane.

Dla przykładu, aby dodać klienta za pomocą mutacji createCustomer należy uprzednio za pomocą query customerAgreements pobrać wszystkie dostępne zgody RODO, przedstawić je klientowi, odebrać akceptację i przesłać je w postaci encji zawierającej ID zgody i stanu akceptacji.

W innym przykładzie, aby dodać naprawę za pomocą mutacji createRepair należy podać typ naprawianego sprzętu. Zatem przed dodaniem naprawy należy za pomocą query dictionaryEntries pobrać wszystkie typy, przedstawić je klientowi, np. w postaci listy wyboru - zaś wybrany identyfikator ID przesłać jako type do encji tworzącej naprawę.

Kolejność operacji w procesie zazwyczaj odowiada kolejności operacji w interfejsie webowym aplikacji, dlatego jeśli nie wiesz jak powinna wyglądać ta kolejność, sprawdź jak wykonuje się daną operację w aplikacji webowej.

Inne wskazówki

Zawsze zwracaj uwagę na typ zwracany lub przyjmowany. To on decyduje o tym, co zostanie zwrócone lub przyjęte, nie nazwa. Np, w odpowiedziach na query identyfkator relacji HashID ma nazwę ID, w mutacjach natomiast nazywa się tak, jak encja, którą opisuje, czyli np. customer, type.

Daty przesyłamy w formacie ISO 8601 wraz ze strefą czasową.