SelSup Developers

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

Өндүрүүчүлөр

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

5 чектөө пункттары/api/manufacturerТуруктууМашина менен окулуучу сүрөттөмө ↗
{ }

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

/api/manufacturer

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

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

01

Өндүрүүчүлөрдү колдонууну баштаңыз

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

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

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

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

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

Manufacturer11 аймактар
manufacturerIdinteger · int32

Өндүрүүчү ID.

titlestring

Аталышы.

namestring

Аты.

Милдеттүү
addressstring

Дарек.

organizationIdinteger · int64

Уюмдун идентификатору.

clientIdinteger · int64

Кардар ID.

read-only
countryIdinteger · int32

Өлкө ID.

countryNamestring

Өлкө аты.

read-only
innstring

Мейманкана.

deletedboolean

Жок кылынды.

oneCIdstring

Бир КИД.

FindResponseManufacturer1 аймактар
rowsManufacturer[]

Саптар.

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

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

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

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

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

GET

Ишкананын өндүрүүчүсүн идентификациялоо

/api/manufacturer/{manufacturerId}
Окуу мүмкүнчүлүгү бар белги

GET /api/manufacturer/{manufacturerId}. колдонуу менен өндүрүүчү ID менен алыңыз

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

ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Ооба Өндүрүүчү ID.
curl --request GET 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
Объекттердин талаалары Manufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Каталар6

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

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

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

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

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

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

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

400error_manufacturer_not_found
Өндүрүүчү табылган жок: {id}

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

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

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

400error_subscription_expired
Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

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

PUT

Жаңыртуу Өндүрүүчү

/api/manufacturer/{manufacturerId}
Жазуу мүмкүнчүлүгү бар белги

PUT /api/manufacturer/{manufacturerId}. колдонгон өндүрүүчү жаңыртуу

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

ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int64 Ооба Өндүрүүчү ID.

Талап боюнча орган

application/json
Объекттердин талааларыManufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
curl --request PUT 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

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

200
Объекттердин талаалары Manufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Каталар7

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

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

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

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

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

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

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

400error_empty_manufacturer_name
Өндүрүүчүнүн аталышы көрсөтүлгөн жок

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

400error_manufacturer_already_exist
{name} аталышындагы өндүрүүчү мурунтан эле бар

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

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

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

400error_subscription_expired
Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

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

DELETE

Өндүрүүчү

/api/manufacturer/{manufacturerId}
Жазуу мүмкүнчүлүгү бар белги

DELETE /api/manufacturer/{manufacturerId}. колдонгон өндүрүүчү

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

ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Ооба Өндүрүүчү ID.

Сурамжылоо параметрлери

ТалааТүрүМилдеттүүСүрөттөмө
deleted boolean Ооба Жок кылынды.
curl --request DELETE 'https://api.selsup.ru/api/manufacturer/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
"string"
Каталар3

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

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

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

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

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

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

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

POST

Өндүрүүчү түзүү

/api/manufacturer
Жазуу мүмкүнчүлүгү бар белги

POST /api/manufacturer. колдонуу менен өндүрүүчү түзүү

Талап боюнча орган

application/json
Объекттердин талааларыManufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
curl --request POST 'https://api.selsup.ru/api/manufacturer' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

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

200
Объекттердин талаалары Manufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Каталар7

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

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

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

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

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

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

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

400error_empty_manufacturer_name
Өндүрүүчүнүн аталышы көрсөтүлгөн жок

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

400error_manufacturer_already_exist
{name} аталышындагы өндүрүүчү мурунтан эле бар

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

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

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

400error_subscription_expired
Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

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

GET

Түшүнүү

/api/manufacturer/find
Окуу мүмкүнчүлүгү бар белги

GET /api/manufacturer/find. колдонуу менен табуу

Сурамжылоо параметрлери

ТалааТүрүМилдеттүүСүрөттөмө
query string Жок Суроо.
manufacturerOneCId string Жок Өндүрүүчү 1 КИД.
limit integer · int32 Жок Чек ара.
page integer · int32 Жок Бет.
count boolean Жок Эсептөөчү.
sortBy stringMANUFACTURERID, NAME Жок Толук түзүлдү.
ascending boolean Жок Төшүп баратат.
curl --request GET 'https://api.selsup.ru/api/manufacturer/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
Объекттердин талаалары FindResponseManufacturer
ТалааТүрүМилдеттүүСүрөттөмө
rows Manufacturer[] Жок Саптар.
Топтун элементтеринин түзүлүшү Manufacturer
ТалааТүрүМилдеттүүСүрөттөмө
manufacturerId integer · int32 Жок Өндүрүүчү ID.
title string Жок Аталышы.
name string Ооба Аты.
address string Жок Дарек.
organizationId integer · int64 Жок Уюмдун идентификатору.
clientId integer · int64 Жок Кардар ID.
countryId integer · int32 Жок Өлкө ID.
countryName string Жок Өлкө аты.
inn string Жок Мейманкана.
deleted boolean Жок Жок кылынды.
oneCId string Жок Бир КИД.
{
  "rows": "string"
}
Каталар5

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

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

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

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

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

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

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

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

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

400error_subscription_expired
Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

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

Authorization

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

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

Байкап көрүү

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

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

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