SelSup Developers

Public API · API Referencja

Konkurenci

Punkty końcowe dla konkurentów, w tym dokładne trasy, parametry, organy składające wnioski oraz rozszerzalne schematy odpowiedzi.

4 punkty końcowe/api/competitorStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/competitor

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać konkurentów

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ą.

Competitor6 pola
idinteger · int64

Id.

read-only
modelIdinteger · int64

Identyczny model.

servicestring

- W służbie.

Wymagane
urlstring

- Url.

Wymagane
serviceIdstring

Id służbowy.

clientIdinteger · int64

Id klientów.

read-only

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

Aktualizacja

/api/competitor/{competitorId}
Token z dostępem do pisania

Aktualizacja za pomocą PUT /api/competitor/{competitorId}.

Parametry ścieżki

PoleTypWymaganeOpis
competitorId integer · int64 Tak Id konkurenta.

Organ wnioskujący

application/json
Połączenia obiektuCompetitor
PoleTypWymaganeOpis
id integer · int64 Nie Id.
modelId integer · int64 Nie Identyczny model.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Tak - W służbie.
url string Tak - Url.
serviceId string Nie Id służbowy.
clientId integer · int64 Nie Id klientów.
curl --request PUT 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Odpowiedź udana

200

Odpowiedź nie ma ciała.

Władze8

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_competitor_id_required
Wymagany jest id konkurenta

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

400error_competitor_required
Konkurent jest wymagany

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

400error_competitor_service_required
Serwis konkurenta jest obowiązkowy

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

400error_competitor_url_required
Link konkurenta jest wymagany

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_url_required; 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.

DELETE

Usuń

/api/competitor/{competitorId}
Token z dostępem do pisania

Usuwanie za pomocą DELETE /api/competitor/{competitorId}.

Parametry ścieżki

PoleTypWymaganeOpis
competitorId integer · int64 Tak Id konkurenta.
curl --request DELETE 'https://api.selsup.ru/api/competitor/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_competitor_id_required
Wymagany jest id konkurenta

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_id_required; 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.

GET

/Wszystko zbierz.

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

Uzyskaj wszystkie za pomocą GET /api/competitor/{modelId}.

Parametry ścieżki

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

Odpowiedź udana

200
Struktura pozycji zestawu Competitor[]
PoleTypWymaganeOpis
id integer · int64 Nie Id.
modelId integer · int64 Nie Identyczny model.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Tak - W służbie.
url string Tak - Url.
serviceId string Nie Id służbowy.
clientId integer · int64 Nie Id klientów.
[
  "string"
]
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_model_id_required
Wymagane id modelu

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_model_id_required; 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.

POST

Stwórz

/api/competitor/{modelId}
Token z dostępem do pisania

Tworzyć za pomocą POST /api/competitor/{modelId}.

Parametry ścieżki

PoleTypWymaganeOpis
modelId integer · int64 Tak Identyczny model.

Organ wnioskujący

application/json
Połączenia obiektuCompetitor
PoleTypWymaganeOpis
id integer · int64 Nie Id.
modelId integer · int64 Nie Identyczny model.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Tak - W służbie.
url string Tak - Url.
serviceId string Nie Id służbowy.
clientId integer · int64 Nie Id klientów.
curl --request POST 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Odpowiedź udana

200
Połączenia obiektu Competitor
PoleTypWymaganeOpis
id integer · int64 Nie Id.
modelId integer · int64 Nie Identyczny model.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Tak - W służbie.
url string Tak - Url.
serviceId string Nie Id służbowy.
clientId integer · int64 Nie Id klientów.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "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_competitor_required
Konkurent jest wymagany

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

400error_competitor_service_required
Serwis konkurenta jest obowiązkowy

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

400error_competitor_url_required
Link konkurenta jest wymagany

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_competitor_url_required; 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.

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.