OptiMES

  1. Home
  2. Docs
  3. OptiMES
  4. Dodatkowe
  5. Poruszanie się po API

Poruszanie się po API

Aby dostać się do API, podajemy adres naszej aplikacji / swagger

[nazwa aplikacji].syneo.pl/swagger

Po wejściu do API otworzy się przed nami możliwość przeglądania endpointów.

Wybieramy interesującą nas sekcję.

Po wybraniu odpowiedniego zasobu API rozwinie się okno, w którym możemy uzupełnić zapytanie. Zobaczymy także przykładowy kod, który zostanie zwrócony. Obok Example Value możemy wybrać opcję Model. W ten sposób rozwinie nam się lista z wyjaśnieniem znaczenia wszystkich pozycji, które pojawią się w zwróconym zapytaniu. 

Przykład

Chcę poznać wartość atrybutu kolor dla danego produktu. Wchodzę do API przez [nazwa aplikacji].syneo.pl/swagger 

Rozwijam zakładkę Warehouse/Products następnie otwieram  GET /api/v1/Warehouse/Products/{id} ponieważ to właśnie po ID będę chciał szukać atrybutu.
Z sekcji Model dowiem się,  gdzie zostaną zwrócone informacje,  których szukam.

Pobieram GETem produkt używając jego ID

Sprawdzam, jakie ID ma interesujący mnie atrybut. Można to zrobić przez:

Ustawienia > Studio > Atrybuty

W odpowiedzi na Get z ID produktu otrzymam kod, w którym:
RuntimeAttributeValueApiDto {
Id (integer, optional):
Id pozycji ,
RuntimeAttributeId (integer):
Id atrybutu
Value (string, optional):
Wartość

W ten sposób pobrałem po API atrybut kolor wybranego produktu. 

Czy ten artykuł był pomocny? Tak Nie

Napisz do nas.