SelSup Developers

Қоғамдық API · API Анықтама

Жарыстар

Кәсіпкерлер үшін нақты бағыттар, параметрлер, сұрау салу органдары және кеңейтілетін жауап схемалары қоса алғанда, қорытынды нүктелер.

12 аяқтық нүктелер/api/competitorТұрақтыМашинамен оқитын сипаттама ↗
{ }

Бұл бетте өңдеуге жарамды жеке келісімшарт бар. Өнімді пайдаланудан бұрын сынақ деректерімен жазу операцияларын растаңыз.

/api/competitor

Қолдануға дайын жұмыс барысы

Қолдануға дайын жұмыс барысы

01

Сапкерлерді қолдануды бастаңыз

API токенін пайдаланып, оқу операцияларын бірінші кезекте тест деректерімен растаңыз.

  1. Сервер жағында белгі сақтап, Authorization бағаншасына жіберіңіз.
  2. Керек параметрлерді тексеріп, сұрау немесе жауап схемасын кеңейтіңіз.
  3. HTTP күйін және error тұрақты өрісін қолданба қателерінде өңдеу.

Деректер моделі

Деректер құрылымы

Модельдер бір рет осы жерде тізімделеді және оларды пайдаланатын соңғы нүктелерден тікелей кеңейтілуі мүмкін.

Competitor10 өрістер
idinteger · int64

Id.

read-only
modelIdinteger · int64

Үлгілік идентификаторы.

productIdinteger · int64

Өнімнің идентификаторы.

servicestring

Қызмет.

Міндетті
urlstring

URL.

Міндетті
serviceIdstring

Қызмет идентификаторы.

clientIdinteger · int64

Клиент танымдығы.

read-only
latestPricenumber · double

Соңғы баға.

read-only
currencystring

Ақша.

read-only
latestPriceDatestring · date-time

Соңғы баға күні.

read-only
CompetitorPrice6 өрістер
idinteger · int64

Id.

read-only
competitorIdinteger · int64

Жарысқа қатысушы ID.

Міндетті
clientIdinteger · int64

Клиент танымдығы.

read-only
pricenumber · double

Баға.

Міндетті
currencystring

Ақша.

datestring · date-time

Кездесу.

CompetitorImportResult2 өрістер
importedinteger · int32

Импортталған.

skippedinteger · int32

Өтірілді.

Қате туралы келісімшарт

Қолданба қателерін қайтару

error коды барлық жерлерде бірдей, ал пайдаланушымен бетпе-бет сөйлейтін хабарлама сервер арқылы аударылады. error-ге арналған қолданба логикасын құру және localMessage-ді көрсету үшін ғана пайдалану.

error

Интеграциялық логика үшін тұрақты машина оқуға болатын код.

localMessage

API белгі пайдаланушы тілінде көрсетілуге дайын хабарлама.

params

Сервердің жергілікті хабарлама үлгісіне интерполациялаған мәндері.

文

localMessage API белгісін иеленуші пайдаланушының lang өрісін пайдаланады. Құжаттама тілі мен Accept-Language баған оны өзгертпейді; орыс тілі пайдаланушының тілі конфигурацияланбаған кезде қолданылады.

RUПайдаланушы жері ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
KKҚазақша (kk)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base бренді бұрыннан бар",
  "params": {
    "name": "Base"
  }
}

Аяқ нүктелері

Аяқ нүктелері

PUT

Жаңарту

/api/competitor/{competitorId}
Жазуға қол жеткізуге мүмкіндік беретін белгі

PUT /api/competitor/{competitorId}. арқылы жаңарту

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
competitorId integer · int64 Иә Жарысқа қатысушы ID.

Өтініш органы

application/json
Нысан өрістеріCompetitor
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
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,
  "productId": 1001,
  "serviceId": "string"
}'

Жеңіспен жауап

200

Жауаптың денесі жоқ.

Қателер9

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_id_required
Бәсекелестің id міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_id_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_not_found
Бәсекелес табылмады

Аяқ нүктесі error. Қолданба логикада error_competitor_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_required
Бәсекелес міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_url_required
Бәсекелес сілтемесі міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_url_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_service_not_supported
Қызмет қолдау көрсетпейді

Аяқ нүктесі error. Қолданба логикада error_service_not_supported тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

DELETE

Жою

/api/competitor/{competitorId}
Жазуға қол жеткізуге мүмкіндік беретін белгі

DELETE /api/competitor/{competitorId}. арқылы өшіру

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
competitorId integer · int64 Иә Жарысқа қатысушы ID.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200

Жауаптың денесі жоқ.

Қателер6

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_id_required
Бәсекелестің id міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_id_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_not_found
Бәсекелес табылмады

Аяқ нүктесі error. Қолданба логикада error_competitor_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

GET

Барлығын алып

/api/competitor/{modelId}
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/{modelId}. арқылы бәрін алу

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
modelId integer · int64 Иә Үлгілік идентификаторы.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
Сызық элементтерінің құрылымы Competitor[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
[
  "string"
]
Қателер5

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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 Иә Үлгілік идентификаторы.

Өтініш органы

application/json
Нысан өрістеріCompetitor
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
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,
  "productId": 1001,
  "serviceId": "string"
}'

Жеңіспен жауап

200
Нысан өрістері Competitor
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "productId": 1001,
  "serviceId": "string"
}
Қателер7

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_required
Бәсекелес міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_url_required
Бәсекелес сілтемесі міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_url_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_service_not_supported
Қызмет қолдау көрсетпейді

Аяқ нүктесі error. Қолданба логикада error_service_not_supported тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

GET

Өнімге қарай алыңыз

/api/competitor/product/{productId}
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/product/{productId}. арқылы өнімге ие болу

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
productId integer · int64 Иә Өнімнің идентификаторы.
curl --request GET 'https://api.selsup.ru/api/competitor/product/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
Сызық элементтерінің құрылымы Competitor[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
[
  "string"
]
Қателер5

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_product_not_found
Тауар табылмады

Аяқ нүктесі error. Қолданба логикада error_product_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

POST

Өнім үшін жасау

/api/competitor/product/{productId}
Жазуға қол жеткізуге мүмкіндік беретін белгі

POST /api/competitor/product/{productId}. арқылы өнім үшін құру

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
productId integer · int64 Иә Өнімнің идентификаторы.

Өтініш органы

application/json
Нысан өрістеріCompetitor
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
curl --request POST 'https://api.selsup.ru/api/competitor/product/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "productId": 1001,
  "serviceId": "string"
}'

Жеңіспен жауап

200
Нысан өрістері Competitor
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "productId": 1001,
  "serviceId": "string"
}
Қателер8

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_required
Бәсекелес міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_url_required
Бәсекелес сілтемесі міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_url_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_product_not_found
Тауар табылмады

Аяқ нүктесі error. Қолданба логикада error_product_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_service_not_supported
Қызмет қолдау көрсетпейді

Аяқ нүктесі error. Қолданба логикада error_service_not_supported тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

POST

Бағаларды құру

/api/competitor/price/batch
Жазуға қол жеткізуге мүмкіндік беретін белгі

POST /api/competitor/price/batch. арқылы бағаны құру

Өтініш органы

application/json
Сызық элементтерінің құрылымыCompetitorPrice[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
competitorId integer · int64 Иә Жарысқа қатысушы ID.
clientId integer · int64 Жоқ Клиент танымдығы.
price number · double Иә Баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
date string · date-time Жоқ Кездесу.
curl --request POST 'https://api.selsup.ru/api/competitor/price/batch' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '[
  "string"
]'

Жеңіспен жауап

200
1
Қателер8

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_id_required
Бәсекелестің id міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_id_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_not_found
Бәсекелес табылмады

Аяқ нүктесі error. Қолданба логикада error_competitor_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_price_required
Бәсекелестің дұрыс бағасын енгізіңіз

Аяқ нүктесі error. Қолданба логикада error_competitor_price_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_prices_required
Бәсекелестердің бағаларын беріңіз

Аяқ нүктесі error. Қолданба логикада error_competitor_prices_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

POST

Импорттық бәсекелестер

/api/competitor/import
Жазуға қол жеткізуге мүмкіндік беретін белгі

POST /api/competitor/import. пайдаланушы бәсекелестерді импорттау

Өтініш органы

multipart/form-data
ӨрісТүріМіндеттіСипаттама
file string · binary Иә Файл.
curl --request POST 'https://api.selsup.ru/api/competitor/import' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --form 'file=@./file.bin'

Жеңіспен жауап

200
Нысан өрістері CompetitorImportResult
ӨрісТүріМіндеттіСипаттама
imported integer · int32 Жоқ Импортталған.
skipped integer · int32 Жоқ Өтірілді.
{
  "imported": 1,
  "skipped": 1
}
Қателер10

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_competitor_required
Бәсекелес міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_competitor_url_required
Бәсекелес сілтемесі міндетті

Аяқ нүктесі error. Қолданба логикада error_competitor_url_required тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_incorrect_excel
Файлдың пішімі дұрыс емес. Excel кестесін жүктеңіз.

Аяқ нүктесі error. Қолданба логикада error_incorrect_excel тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_max_upload_size_exceeded
Файлдың рұқсат етілген өлшемі асып кетті

Аяқ нүктесі error. Қолданба логикада error_max_upload_size_exceeded тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_products_not_found
Келесі тауарлар табылмады: {products}

Аяқ нүктесі error. Қолданба логикада error_products_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_service_not_supported
Қызмет қолдау көрсетпейді

Аяқ нүктесі error. Қолданба логикада error_service_not_supported тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

GET

Бағаларды алу

/api/competitor/{competitorId}/price
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/{competitorId}/price. арқылы бағаны алу

Жол параметрлері

ӨрісТүріМіндеттіСипаттама
competitorId integer · int64 Иә Жарысқа қатысушы ID.

Сұраныс параметрлері

ӨрісТүріМіндеттіСипаттама
dateFrom string · date-time Жоқ Күні бойы.
dateTo string · date-time Жоқ Күні бүгін.
curl --request GET 'https://api.selsup.ru/api/competitor/1001/price' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
Сызық элементтерінің құрылымы CompetitorPrice[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
competitorId integer · int64 Иә Жарысқа қатысушы ID.
clientId integer · int64 Жоқ Клиент танымдығы.
price number · double Иә Баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
date string · date-time Жоқ Кездесу.
[
  "string"
]
Қателер3

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

GET

Үлгілерді алу

/api/competitor/template
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/template. арқылы үлгісін алу

Сұраныс параметрлері

ӨрісТүріМіндеттіСипаттама
organizationId integer · int64 Жоқ Ұйымның жеке куәлігі.
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, TEKSHER Жоқ Қызмет.
curl --request GET 'https://api.selsup.ru/api/competitor/template' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
"string"
Қателер3

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

GET

Жинақтау үшін кіріс

/api/competitor/collection
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/collection. арқылы жинауға қол жеткіз

curl --request GET 'https://api.selsup.ru/api/competitor/collection' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
Сызық элементтерінің құрылымы Competitor[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
[
  "string"
]
Қателер4

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

GET

Барлығын 1

/api/competitor/
Оқуға қол жеткізуге мүмкіндік беретін белгі

GET /api/competitor/. арқылы барлық 1 -ді алу

curl --request GET 'https://api.selsup.ru/api/competitor/' \
  --header 'Authorization: YOUR_API_TOKEN'

Жеңіспен жауап

200
Сызық элементтерінің құрылымы Competitor[]
ӨрісТүріМіндеттіСипаттама
id integer · int64 Жоқ Id.
modelId integer · int64 Жоқ Үлгілік идентификаторы.
productId integer · int64 Жоқ Өнімнің идентификаторы.
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, TEKSHER Иә Қызмет.
url string Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
latestPrice number · double Жоқ Соңғы баға.
currency stringRUB, USD, EUR, AUD, AZN, GBP, AMD, BYN, BGN, BRL, HUF, VND, HKD, GEL, DKK, AED, EGP, INR, IDR, KZT, CAD, QAR, KGS, CNY, MDL, NZD, NOK, PLN, RON, XDR, SGD, TJS, THB, TRY, TMT, UZS, UAH, CZK, SEK, CHF, RSD, ZAR, KRW, JPY Жоқ Ақша.
latestPriceDate string · date-time Жоқ Соңғы баға күні.
[
  "string"
]
Қателер3

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

Authorization

Сынақ өтiнiштерiне арналған белгі

Токен осы браузердің локальдық сақтауында қалады және api.selsup.ru-ға Authorization сұраныс басында ғана жіберіледі.

Байқап көру

Шын сұраныс параметрлері

Тікелей API жауап

SelSup жауапын көру үшін сұрау жіберу.