SelSup Developers

Коомдук API · API Сүрөт

Медиа

Медиа үчүн акыркы пункттар, анын ичинде так маршруттар, параметрлер, суроо-талап органдары жана кеңейтилген жооп схемалары.

1 чектөө пункттары/api/media/order/{orderId}/videoТуруктууМашина менен окулуучу сүрөттөмө ↗
{ }

Бул барак түзөтүлүүчү өз алдынча келишим менен камсыз кылынат.

/api/media/order/{orderId}/video

Колдонууга даяр жумуш жүрүштөрү

Колдонууга даяр жумуш жүрүштөрү

01

Медианы колдонууну баштаңыз

API белгисин колдонуп, биринчиден тесттик маалыматтар менен окуу операцияларын тастыктаңыз.

  1. Токенди сервер тарапка сактап, Authorization башкыга жөнөт.
  2. Керектүү параметрлерди текшерип, суроо же жооп схемасын кеңейтүү.
  3. HTTP абалы жана error туруктуу талаасы колдонмо каталарында иштелип чыгышы керек.

Маалыматтын модели

Маалыматтар структурасы

Бул жерде моделдер бир жолу көрсөтүлгөн жана аларды колдонгон акыркы пункттардан түздөн-түз кеңейтилген.

Келишимдин катасы

Колдонмо каталарын кантип кайтаруу керек

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"
  }
}

Акыркы пункттар

Акыркы пункттар

POST

Видео жүктөө буйругу

/api/media/order/{orderId}/video
Жазуу мүмкүнчүлүгү бар белги

POST /api/media/order/{orderId}/video. аркылуу видео жүктөп алуу

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

ТалааТүрүМилдеттүүСүрөттөмө
orderId integer · int64 Ооба Түзөтүү ID.
curl --request POST 'https://api.selsup.ru/api/media/order/1001/video' \
  --header 'Authorization: YOUR_API_TOKEN'

Ийгиликтүү жооп

200

Бул жооптун денеси жок.

Каталар6

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

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

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

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

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

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

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

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

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

400error_order_not_found
Заказ табылган жок

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

400error_storage_size_exceeded
Сиз файл сактагычтын өлчөмүнүн чегинен аштыңыз: {limit} Мб

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

Authorization

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

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

Байкап көрүү

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

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

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