SelSup Developers

API · API Ma'lumotnoma

Oʻrnatish

So'rovlar uchun aniq yo'nalishlar, parametrlar, talablar organlari va kengaytirilgan javob sxemalari o'z ichiga olgan sozlamalar uchun oxirgi nuqtalar.

3 yakuniy nuqtalar/api/propertyTurg'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/property

Ishga tayyor ish oqimlari

Ishga tayyor ish oqimlari

01

Oʻrnatishlardan foydalanish

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.

Property6 maydonlar
organizationIdinteger · int64

Tashkilot identifikatori.

clientIdinteger · int64

Mijozning identifikatori.

read-only
componentstring

Komponent.

namestring

Ism.

valuestring

Qiymat.

valueNamestring

Qiymat nomi.

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

Mulkni qoʻying

/api/property/
Yozib olish imkoniyatiga ega token

PUT /api/property/. yordamida mulk qoʻyish

Talabnoma organi

application/json
Ob'ekt maydonlariProperty
MaydonTurMajburiyTavsif
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
clientId integer · int64 Yoʻq Mijozning identifikatori.
component string Yoʻq Komponent.
name string Yoʻq Ism.
value string Yoʻq Qiymat.
valueName string Yoʻq Qiymat nomi.
curl --request PUT 'https://api.selsup.ru/api/property/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "organizationId": 1001,
  "clientId": 1001,
  "component": "string",
  "name": "Example",
  "value": "string",
  "valueName": "Example"
}'

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_invalid_currency_source
Указанный источник курса валют не поддерживается

Uchrashuvda error-dan foydalanish. error_invalid_currency_source 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

Oʻzingni olib ket

/api/property/{organizationId}/{component}
Oʻqish imkoniyatiga ega token

GET /api/property/{organizationId}/{component}.dan foydalaning

Yo'l parametrlari

MaydonTurMajburiyTavsif
organizationId integer · int64 Ha Tashkilot identifikatori.
component string Ha Komponent.
curl --request GET 'https://api.selsup.ru/api/property/1001/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
"string"
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_header_logo_upload_failed
Could not upload the logo. Please try again.

Uchrashuvda error-dan foydalanish. error_header_logo_upload_failed 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.

400error_ozon_fbo_workflow_not_found
Ozon FBO jarayoni {id} topilmadi

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

400error_user_does_not_have_this_organization
Foydalanuvchi ushbu tashkilotga kirish huquqiga ega emas

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

GET

Ro'yxat

/api/property/list/{component}
Oʻqish imkoniyatiga ega token

GET /api/property/list/{component}. qoʻllanilgan roʻyxat

Yo'l parametrlari

MaydonTurMajburiyTavsif
component string Ha Komponent.

Soʻrov parametrlari

MaydonTurMajburiyTavsif
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
curl --request GET 'https://api.selsup.ru/api/property/list/string' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Array elementining tuzilishi Property[]
MaydonTurMajburiyTavsif
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
clientId integer · int64 Yoʻq Mijozning identifikatori.
component string Yoʻq Komponent.
name string Yoʻq Ism.
value string Yoʻq Qiymat.
valueName string Yoʻq Qiymat nomi.
[
  "string"
]
Xatolar4

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_subscription_expired
У вас закончился срок действия тарифа. Оплатите тариф для продолжения использования сервиса.

Uchrashuvda error-dan foydalanish. error_subscription_expired 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.