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

Кардар ID.

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"
  }
}
KYКыргызча (ky)
{
  "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 Жок Макеттик идентификация.
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 Жок Кардар ID.
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 керек

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_id_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_competitor_required
Атаандаш милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_competitor_service_required
Атаандаштын кызматы милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_service_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_competitor_url_required
Атаандаштын шилтемеси милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_url_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Endpoint-specific 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 жана params менен JSON катары кайтарылат. error тармагы; жергиликтүү текст өзгөрүшү мүмкүн. Колдонмо каталарын кантип кайтаруу керек ↑

401auth_required
Ырасмий күбөлөндүрүү талап кылынат

Authorization жок, бош же жараксыз белгиси бар.

400error_access_denied
Кирүүгө тыюу салынган

Токен бар, бирок анын ролу бул операцияны аткара албайт.

500error_unknown
Белгисиз ката кетти. Эгерде көйгөй кайталанса, колдоо кызматына жазыңыз

Ички бузулуу. Суроо убактысын жана байланыш колдоосун үнөмдөө; мутацияны кайрадан сокурдук менен аракет кылбаңыз.

400error_competitor_id_required
Атаандаштын id керек

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_id_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Endpoint-specific 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 Жок Кардар ID.
[
  "string"
]
Каталар5

Колдонмо каталары JSON, error жана params менен JSON катары кайтарылат. error тармагы; жергиликтүү текст өзгөрүшү мүмкүн. Колдонмо каталарын кантип кайтаруу керек ↑

401auth_required
Ырасмий күбөлөндүрүү талап кылынат

Authorization жок, бош же жараксыз белгиси бар.

400error_access_denied
Кирүүгө тыюу салынган

Токен бар, бирок анын ролу бул операцияны аткара албайт.

500error_unknown
Белгисиз ката кетти. Эгерде көйгөй кайталанса, колдоо кызматына жазыңыз

Ички бузулуу. Суроо убактысын жана байланыш колдоосун үнөмдөө; мутацияны кайрадан сокурдук менен аракет кылбаңыз.

400error_model_id_required
Моделдин idси талап кылынат

Endpoint-specific error. Колдонмо логикасында туруктуу error_model_id_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Endpoint-specific 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 Жок Кардар ID.
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 Жок Кардар ID.
{
  "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
Атаандаш милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_competitor_service_required
Атаандаштын кызматы милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_service_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_competitor_url_required
Атаандаштын шилтемеси милдеттүү

Endpoint-specific error. Колдонмо логикасында туруктуу error_competitor_url_required кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

400error_no_client
Клиент не найден или был удален. Напишите в поддержку

Endpoint-specific error. Колдонмо логикасында туруктуу error_no_client кодун колдонуңуз; localMessage жогоруда көрсөтүлгөн котормону камтыйт.

Authorization

Сынак өтүнүчтөрү үчүн белги

Токен бул браузердин локалдык сактагычында калат жана API.selsup.ru сайтына Authorization өтүнүч башкычасында гана жөнөтүлөт.

Байкап көрүү

Чыныгы өтүнүч параметрлери

API түздөн-түз жооп

SelSup жоопту көрүү үчүн өтүнүч жөнөтүү.