SelSup Developers

Грамадскае API · API Падпісанне

Канкурэнты

Канчатковыя пункты для канкурэнтаў, уключаючы дакладныя маршруты, параметры, органы запыту і схемы рэакцыі, якія могуць быць пашыраны.

4 канчатковыя пункты/api/competitorСтабільныМашыначытна чытае апісанне ↗
{ }

Гэты старонка падтрымліваецца рэдагаваць самастойны кантракт.

/api/competitor

Готовыя да выкарыстання працоўныя патокі

Готовыя да выкарыстання працоўныя патокі

01

Пачніце выкарыстоўваць канкурэнтаў

Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.

  1. Захоўвайце знак з боку сервера і адправіце яго ў заголоўку Authorization.
  2. Праверце патрабаваныя параметры і пашырыць схему запыту або адказу.
  3. Выкарыстоўвайце стан HTTP і стабільнае поле error ў памылках прыкладання.

Мадэль дадзеных

Структуры дадзеных

Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.

Competitor6 палёў
idinteger · int64

Id.

read-only
modelIdinteger · int64

Мадэль ID.

servicestring

Паслуга.

Абавязкова
urlstring

Ураль.

Абавязкова
serviceIdstring

Паслуга ID.

clientIdinteger · int64

Ідэнтыфікатар кліента.

read-only

Памылка дагавор

Як вяртаюць памылкі прыкладання

Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.

error

Стабільны машыначытай код для інтэграцыйнай логікі.

localMessage

Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.

params

Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.

localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.

RUМясцовасць карыстальніка ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
BEБеларуская (be)
{
  "error": "error_brand_already_exists",
  "localMessage": "Брэнд Base ужо існуе",
  "params": {
    "name": "Base"
  }
}

Канчатковыя пункты

Канчатковыя пункты

PUT

Абноўленне

/api/competitor/{competitorId}
Знак з пісьмовым доступам

Абноўленне з дапамогай PUT /api/competitor/{competitorId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
competitorId integer · int64 Так Ід канкурэнта.

Запытвальны орган

application/json
Палі аб'ектаўCompetitor
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
modelId integer · int64 Не Мадэль ID.
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 Так Паслуга.
url string Так Ураль.
serviceId string Не Паслуга ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
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
}'

Удалы адказ

200

Адказ не мае цела.

Памылкі8

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_competitor_id_required
Патрабуецца id канкурэнта

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_competitor_required
Канкурэнт абавязковы

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_competitor_service_required
Сэрвіс канкурэнта абавязковы

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_service_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_competitor_url_required
Спасылка канкурэнта абавязковая

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_url_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

DELETE

Выдаліць

/api/competitor/{competitorId}
Знак з пісьмовым доступам

Выміраць з дапамогай DELETE /api/competitor/{competitorId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
competitorId integer · int64 Так Ід канкурэнта.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі5

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_competitor_id_required
Патрабуецца id канкурэнта

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Знайдзіце ўсё

/api/competitor/{modelId}
Значок з чытальным доступам

Атрымаць усё з дапамогай GET /api/competitor/{modelId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
modelId integer · int64 Так Мадэль ID.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Структура элементаў масіва Competitor[]
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
modelId integer · int64 Не Мадэль ID.
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 Так Паслуга.
url string Так Ураль.
serviceId string Не Паслуга ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
[
  "string"
]
Памылкі5

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_model_id_required
Патрабуецца id мадэлі

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_model_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

POST

Стварэнне

/api/competitor/{modelId}
Знак з пісьмовым доступам

Стварэнне з дапамогай POST /api/competitor/{modelId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
modelId integer · int64 Так Мадэль ID.

Запытвальны орган

application/json
Палі аб'ектаўCompetitor
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
modelId integer · int64 Не Мадэль ID.
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 Так Паслуга.
url string Так Ураль.
serviceId string Не Паслуга ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
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
}'

Удалы адказ

200
Палі аб'ектаў Competitor
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
modelId integer · int64 Не Мадэль ID.
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 Так Паслуга.
url string Так Ураль.
serviceId string Не Паслуга ID.
clientId integer · int64 Не Ідэнтыфікатар кліента.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
Памылкі7

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

400error_competitor_required
Канкурэнт абавязковы

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_competitor_service_required
Сэрвіс канкурэнта абавязковы

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_service_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_competitor_url_required
Спасылка канкурэнта абавязковая

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_url_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

Authorization

Знак для запытаў на выпрабаванне

Токен застаецца ў лакальным сховішчы гэтага браўзэра і адпраўляецца толькі ў заголоўцы Authorization запытаў на api.selsup.ru.

Паспрабаваць

Рэальныя параметры запыту

Жывы адказ API

Пашляце запыт, каб убачыць адказ SelSup.