SelSup Developers

Қоғамдық API · API Анықтама

Өндiрушiлер

Өндірушілер үшін соңғы нүктелер, соның ішінде нақты бағыттар, параметрлер, сұрау салу органдары және кеңейтілетін жауап схемалары.

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

Бұл бетте өңдеуге жарамды жеке келісімшарт бар. Өнімді пайдаланудан бұрын сынақ деректерімен жазу операцияларын растаңыз.

/api/manufacturer

Қолдануға дайын жұмыс барысы

Қолдануға дайын жұмыс барысы

01

Өнім өндірушілерді қолдануды бастаңыз

API токенін пайдаланып, оқу операцияларын бірінші кезекте тест деректерімен растаңыз.

  1. Сервер жағында белгі сақтап, Authorization бағаншасына жіберіңіз.
  2. Керек параметрлерді тексеріп, сұрау немесе жауап схемасын кеңейтіңіз.
  3. HTTP күйін және error тұрақты өрісін қолданба қателерінде өңдеу.

Деректер моделі

Деректер құрылымы

Модельдер бір рет осы жерде тізімделеді және оларды пайдаланатын соңғы нүктелерден тікелей кеңейтілуі мүмкін.

Manufacturer11 өрістер
manufacturerIdinteger · int32

Өндіруші ID.

titlestring

Атауы.

namestring

Есім.

Міндетті
addressstring

Адрес.

organizationIdinteger · int64

Ұйымның жеке куәлігі.

clientIdinteger · int64

Клиент танымдығы.

read-only
countryIdinteger · int32

Елдік идентификаторы.

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"
  }
}
KKҚазақша (kk)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base бренді бұрыннан бар",
  "params": {
    "name": "Base"
  }
}

Аяқ нүктелері

Аяқ нүктелері

GET

Өндiрушiнiң жеке куәлігі бойынша алыңыз

/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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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}

Аяқ нүктесі error. Қолданба логикада error_manufacturer_not_found тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_subscription_expired
Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі 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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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
Не указано название производителя

Аяқ нүктесі error. Қолданба логикада error_empty_manufacturer_name тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_manufacturer_already_exist
{name} атауымен өндіруші бар

Аяқ нүктесі error. Қолданба логикада error_manufacturer_already_exist тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_subscription_expired
Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі 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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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
Не указано название производителя

Аяқ нүктесі error. Қолданба логикада error_empty_manufacturer_name тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_manufacturer_already_exist
{name} атауымен өндіруші бар

Аяқ нүктесі error. Қолданба логикада error_manufacturer_already_exist тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_no_client
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_subscription_expired
Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі 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 Жоқ Клиент танымдығы.
countryId integer · int32 Жоқ Елдік идентификаторы.
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
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі error. Қолданба логикада error_no_client тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

400error_subscription_expired
Тарифтің қолданылу мерзімі аяқталды. Қызметті пайдалануды жалғастыру үшін тарифті төлеңіз.

Аяқ нүктесі error. Қолданба логикада error_subscription_expired тұрақты кодын қолданыңыз; localMessage жоғарыда көрсетілген аударманы қамтиды.

Authorization

Сынақ өтiнiштерiне арналған белгі

Токен осы браузердің локальдық сақтауында қалады және api.selsup.ru-ға Authorization сұраныс басында ғана жіберіледі.

Байқап көру

Шын сұраныс параметрлері

Тікелей API жауап

SelSup жауапын көру үшін сұрау жіберу.