SelSup Developers

API · API Ma'lumotnoma

Raqobatchilar

Raqobatchilar uchun yakuniy nuqtalar, shu jumladan aniq yo'nalishlar, parametrlar, talab organlari va kengaytiriladigan javob sxemalari.

4 yakuniy nuqtalar/api/competitorTurg'unMashina o'qiladigan tavsif ↗
{ }

Ushbu sahifani tahrirlash mumkin bo'lgan mustaqil shartnoma bilan ta'minlaydi. Ishlab chiqarishdan oldin sinov ma'lumotlari bilan yozish operatsiyalarini tasdiqlash.

/api/competitor

Ishga tayyor ish oqimlari

Ishga tayyor ish oqimlari

01

Raqobatchilardan foydalanishni boshlash

API tokenidan foydalaning va avval o'qish operatsiyalarini sinov ma'lumotlari bilan tasdiqlash.

  1. Tokeni server tomoniga saqlang va Authorization boshliqida yuboring.
  2. Kerakli parametrlarni tekshiring va so'rov yoki javob sxemasini kengaytiring.
  3. HTTP holatini va error o'rniga dastur xatolarida ishlash.

Ma'lumotlar modeli

Ma'lumotlar tuzilmalari

Modellari bu yerda bir marta ro'yxatga olingan va ularni ishlatadigan oxirgi nuqtalardan to'g'ridan-to'gʻri kengaytirilishi mumkin.

Competitor6 maydonlar
idinteger · int64

Id.

read-only
modelIdinteger · int64

Model ID.

servicestring

Xizmat.

Majburiy
urlstring

Url.

Majburiy
serviceIdstring

Xizmat guvohnomasi.

clientIdinteger · int64

Mijozning identifikatori.

read-only

Xato shartnomasi

Ilovalar xatolarini qaytarib berish usuli

error kodlari har bir joyda bir xil, foydalanuvchiga qaratilgan xabar server tomonidan tarjima qilinadi. error atrofida dastur mantiqasini quring va localMessage-dan faqat ko'rsatish uchun foydalaning.

error

Integratsiya mantiqasini yaratish uchun barqaror mashina o'qiladigan kod.

localMessage

API token foydalanuvchisining tilida ko'rsatishga tayyor xabar.

params

Server tomonidan mahalliylashtirilgan xabar namunalariga interpolatsiya qilingan qiymatlar.

localMessage API tokenini egallagan foydalanuvchining lang maydoni ishlatiladi. Hujjat tili va Accept-Language boshliq uni o'zgartirmaydi; foydalanuvchi tilni moslamasa rus tilida ishlatiladigan.

RUFoydalanuvchi manzili ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
UZOʻzbekcha (uz)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base brendi allaqachon mavjud",
  "params": {
    "name": "Base"
  }
}

Keyingi nuqtalar

Keyingi nuqtalar

PUT

Yangilanish

/api/competitor/{competitorId}
Yozib olish imkoniyatiga ega token

PUT /api/competitor/{competitorId}. yordamida yangilanish

Yo'l parametrlari

MaydonTurMajburiyTavsif
competitorId integer · int64 Ha Raqobatchi ID.

Talabnoma organi

application/json
Ob'ekt maydonlariCompetitor
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
modelId integer · int64 Yoʻq Model 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 Ha Xizmat.
url string Ha Url.
serviceId string Yoʻq Xizmat guvohnomasi.
clientId integer · int64 Yoʻq Mijozning identifikatori.
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
}'

Muvaffaqiyatli javob

200

Javobning tanasi yo'q.

Xatolar8

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_competitor_id_required
Raqibning id si talab qilinadi

Uchrashuvda error-dan foydalanish. error_competitor_id_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_competitor_required
Raqobatchi majburiy

Uchrashuvda error-dan foydalanish. error_competitor_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_competitor_service_required
Raqobatchi xizmati majburiy

Uchrashuvda error-dan foydalanish. error_competitor_service_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_competitor_url_required
Raqobatchi havolasi majburiy

Uchrashuvda error-dan foydalanish. error_competitor_url_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing

Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

DELETE

Oʻchirish

/api/competitor/{competitorId}
Yozib olish imkoniyatiga ega token

DELETE /api/competitor/{competitorId}. yordamida oʻchirish

Yo'l parametrlari

MaydonTurMajburiyTavsif
competitorId integer · int64 Ha Raqobatchi ID.
curl --request DELETE 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200

Javobning tanasi yo'q.

Xatolar5

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_competitor_id_required
Raqibning id si talab qilinadi

Uchrashuvda error-dan foydalanish. error_competitor_id_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing

Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

GET

Hamma narsani oling

/api/competitor/{modelId}
Oʻqish imkoniyatiga ega token

GET /api/competitor/{modelId}. yordamida hamma narsani olish

Yo'l parametrlari

MaydonTurMajburiyTavsif
modelId integer · int64 Ha Model ID.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Array elementining tuzilishi Competitor[]
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
modelId integer · int64 Yoʻq Model 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 Ha Xizmat.
url string Ha Url.
serviceId string Yoʻq Xizmat guvohnomasi.
clientId integer · int64 Yoʻq Mijozning identifikatori.
[
  "string"
]
Xatolar5

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_model_id_required
Требуется id модели

Uchrashuvda error-dan foydalanish. error_model_id_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing

Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

POST

yaratish

/api/competitor/{modelId}
Yozib olish imkoniyatiga ega token

POST /api/competitor/{modelId}. yordamida yaratish

Yo'l parametrlari

MaydonTurMajburiyTavsif
modelId integer · int64 Ha Model ID.

Talabnoma organi

application/json
Ob'ekt maydonlariCompetitor
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
modelId integer · int64 Yoʻq Model 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 Ha Xizmat.
url string Ha Url.
serviceId string Yoʻq Xizmat guvohnomasi.
clientId integer · int64 Yoʻq Mijozning identifikatori.
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
}'

Muvaffaqiyatli javob

200
Ob'ekt maydonlari Competitor
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
modelId integer · int64 Yoʻq Model 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 Ha Xizmat.
url string Ha Url.
serviceId string Yoʻq Xizmat guvohnomasi.
clientId integer · int64 Yoʻq Mijozning identifikatori.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}
Xatolar7

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

400error_competitor_required
Raqobatchi majburiy

Uchrashuvda error-dan foydalanish. error_competitor_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_competitor_service_required
Raqobatchi xizmati majburiy

Uchrashuvda error-dan foydalanish. error_competitor_service_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_competitor_url_required
Raqobatchi havolasi majburiy

Uchrashuvda error-dan foydalanish. error_competitor_url_required kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

400error_no_client
Mijoz topilmadi yoki o'chirilgan. Qo'llab-quvvatlash xizmatiga yozing

Uchrashuvda error-dan foydalanish. error_no_client kodini qo'llash logikasida ishlating; localMessageda yuqorida ko'rsatilgan tarjima mavjud.

Authorization

Sinov talablari uchun belgisi

Token ushbu brauzerning localStorage-da qoladi va faqat api.selsup.ru nomli so'rovlarning Authorization boshliqida yuboriladi.

Sinab koʻrish

Haqiqiy talab parametrlari

API- ning jonli javoblari

SelSup javobini ko'rish uchun iltimos yuboring.