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

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

servicestring

Қызмет.

Міндетті
urlstring

URL.

Міндетті
serviceIdstring

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

clientIdinteger · int64

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

read-only

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

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

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 Жоқ Үлгілік идентификаторы.
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 Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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 Иә Жарысқа қатысушы ID.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

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

Қателер5

Қолданба қателері 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_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 Жоқ Үлгілік идентификаторы.
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 Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
[
  "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 Жоқ Үлгілік идентификаторы.
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 Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
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 Жоқ Үлгілік идентификаторы.
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 Иә URL.
serviceId string Жоқ Қызмет идентификаторы.
clientId integer · int64 Жоқ Клиент танымдығы.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
Қателер7

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

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

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

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

Байқап көру

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

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

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