SelSup Developers

Public API · API Referencja

Tag produktów

Punkty końcowe dla etykiet produktów, w tym dokładne trasy, parametry, organy żądania i rozszerzalne schematy odpowiedzi.

9 punkty końcowe/api/tagStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/tag

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać tagów Produktu

Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.

  1. Trzymaj token z serwera i wysłać go w nagłówku Authorization.
  2. Sprawdź wymagane parametry i poszerz schemat żądania lub odpowiedzi.
  3. Zrób z statusem HTTP i stabilnym pole error w przypadku błędów aplikacyjnych.

Model danych

Struktura danych

Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.

ProductTag3 pola
idinteger · int64

Id.

read-only
namestring

- Nazwa.

Wymagane
clientIdinteger · int64

Id klientów.

read-only
FindResponseProductTag1 pola
rowsProductTag[]

Rzędy.

FindResponseProductTagInfo1 pola
rowsProductTagInfo[]

Rzędy.

ProductTagInfo2 pola
productIdinteger · int64

Id produktu.

productTagsProductTag[]

Tagi produktu.

Umowa o błędzie

W jaki sposób można zwrócić błędy w aplikacji

Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.

error

Stabilny kod czytelny maszynowo do logiki integracyjnej.

localMessage

Przesłanie gotowe do wyświetlania w języku użytkownika tokenu API.

params

Wartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.

localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.

RULokalizacja użytkownika jest ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
PLPolski (pl)
{
  "error": "error_brand_already_exists",
  "localMessage": "Marka Base już istnieje",
  "params": {
    "name": "Base"
  }
}

Punkty końcowe

Punkty końcowe

PUT

Tag aktualizacji

/api/tag/{tagId}
Token z dostępem do pisania

Aktualizacja Tag za pomocą PUT /api/tag/{tagId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.

Organ wnioskujący

application/json
Połączenia obiektuProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
curl --request PUT 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu ProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Władze7

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_id_and_name_required
Wymagane są id i nazwa tagu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_id_and_name_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_id_required
Wymagany jest id tagu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_update_failed
Nie udało się zaktualizować tagu z id: {0}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_update_failed; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

DELETE

Aktualizacja Tag 1

/api/tag/{tagId}
Token z dostępem do pisania

Aktualizacja Tag 1 za pomocą DELETE /api/tag/{tagId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze3

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

PUT

Wiążenie tag do produktu

/api/tag/product/{tagId}/{productId}
Token z dostępem do pisania

Wiążanie tagów do produktu za pomocą PUT /api/tag/product/{tagId}/{productId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.
productId integer · int64 Tak Id produktu.
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze6

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_duplicate_tag_association
Tag jest już powiązany z produktem

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_duplicate_tag_association; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_and_product_id_required
wymagany jest tag i ID produktu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_and_product_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

DELETE

Un Bind Tag do produktu

/api/tag/product/{tagId}/{productId}
Token z dostępem do pisania

Un Bind Tag Do produktu używając DELETE /api/tag/product/{tagId}/{productId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.
productId integer · int64 Tak Id produktu.
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze5

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_and_model_id_required
Wymagane są id tagu i id modelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_and_model_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

PUT

Wiążę tag do modelu

/api/tag/model/{tagId}/{modelId}
Token z dostępem do pisania

Wiążanie tag do modelu za pomocą PUT /api/tag/model/{tagId}/{modelId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.
modelId integer · int64 Tak Identyczny model.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze6

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_duplicate_tag_association
Tag jest już powiązany z produktem

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_duplicate_tag_association; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_and_model_id_required
Wymagane są id tagu i id modelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_and_model_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

DELETE

Un Bind Tag do modelu

/api/tag/model/{tagId}/{modelId}
Token z dostępem do pisania

Un Bind Tag Do modelu używającego DELETE /api/tag/model/{tagId}/{modelId}.

Parametry ścieżki

PoleTypWymaganeOpis
tagId integer · int64 Tak - Id.
modelId integer · int64 Tak Identyczny model.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze5

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_and_model_id_required
Wymagane są id tagu i id modelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_and_model_id_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

POST

Utworzenie tag

/api/tag
Token z dostępem do pisania

Tegowanie za pomocą POST /api/tag.

Organ wnioskujący

application/json
Połączenia obiektuProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
curl --request POST 'https://api.selsup.ru/api/tag' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu ProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Władze6

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_duplicate_tag_name
Tag o takiej nazwie już istnieje: {0}

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_duplicate_tag_name; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_tag_name_required
Wymagana jest nazwa tagu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_tag_name_required; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

GET

Znajdź tag

/api/tag/find
Token z dostępem do odczytu

Znajdź tagy za pomocą GET /api/tag/find.

Parametry zapytania

PoleTypWymaganeOpis
query string Nie - Nie wiem.
productId integer · int64 Nie Id produktu.
limit integer · int32 Nie Ogranicz.
page integer · int32 Nie Strona.
count boolean Nie Zgromadzisz.
sortBy stringID, NAME Nie - Zarejestrowany.
ascending boolean Nie Wzniesienie.
curl --request GET 'https://api.selsup.ru/api/tag/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu FindResponseProductTag
PoleTypWymaganeOpis
rows ProductTag[] Nie Rzędy.
Struktura pozycji zestawu ProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
{
  "rows": "string"
}
Władze4

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

GET

Znajdź oznaki modelu

/api/tag/find/{modelId}
Token z dostępem do odczytu

Znajdź oznaki modelu za pomocą GET /api/tag/find/{modelId}.

Parametry ścieżki

PoleTypWymaganeOpis
modelId integer · int64 Tak Identyczny model.
curl --request GET 'https://api.selsup.ru/api/tag/find/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu FindResponseProductTagInfo
PoleTypWymaganeOpis
rows ProductTagInfo[] Nie Rzędy.
Struktura pozycji zestawu ProductTagInfo
PoleTypWymaganeOpis
productId integer · int64 Nie Id produktu.
productTags ProductTag[] Nie Tagi produktu.
Struktura pozycji zestawu ProductTag
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Tak - Nazwa.
clientId integer · int64 Nie Id klientów.
{
  "rows": "string"
}
Władze4

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

Authorization

Token do wniosków o badania

Token pozostaje w lokalnym magazynie przeglądarki i jest wysyłany tylko w nagłówku Authorization z wniosków na api.selsup.ru.

Wypróbuj

Prawdziwe parametry żądania

Odpowiedź API

Wyślij wniosek o zapoznanie się z odpowiedzią SelSup.