SelSup Developers

Грамадскае API · API Падпісанне

Вытворцы

Канчатковыя пункты для вытворцаў, уключаючы дакладныя маршруты, параметры, органы запыту і схемы рэакцыі, якія могуць быць пашыраны.

5 канчатковыя пункты/api/manufacturerСтабільныМашыначытна чытае апісанне ↗
{ }

Гэты старонка падтрымліваецца рэдагаваць самастойны кантракт.

/api/manufacturer

Готовыя да выкарыстання працоўныя патокі

Готовыя да выкарыстання працоўныя патокі

01

Пачніце выкарыстоўваць Вытворцы

Выкарыстоўвайце адмысловы токен API і пацвердзіце аперацыі чытання з дадзенымі тэсту спачатку.

  1. Захоўвайце знак з боку сервера і адправіце яго ў заголоўку Authorization.
  2. Праверце патрабаваныя параметры і пашырыць схему запыту або адказу.
  3. Выкарыстоўвайце стан HTTP і стабільнае поле error ў памылках прыкладання.

Мадэль дадзеных

Структуры дадзеных

Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.

Manufacturer11 палёў
manufacturerIdinteger · int32

Ід вытворцы.

titlestring

Назва.

namestring

Назва.

Абавязкова
addressstring

Адрас.

organizationIdinteger · int64

Ід арганізацыі.

clientIdinteger · int64

Ідэнтыфікатар кліента.

read-only
countryIdinteger · int32

Падпісанне краіны.

countryNamestring

Назва краіны.

read-only
innstring

Гасцініца.

deletedboolean

Здарэнне.

oneCIdstring

Адзін ІК.

FindResponseManufacturer1 палёў
rowsManufacturer[]

Рыжкі.

Памылка дагавор

Як вяртаюць памылкі прыкладання

Код error аднолькавы ў кожным лакелі, у той час як паведамленне, якое з'яўляецца карыстальнікам, перакладаецца серверам.

error

Стабільны машыначытай код для інтэграцыйнай логікі.

localMessage

Паведамленне гатовае да адлюстравання на мове карыстальніка токены API.

params

Значэнні, якія інтэрполююцца серверам у лакалізаваным шаблоне паведамленняў.

localMessage выкарыстоўвае поле lang карыстальніка, які валодае токеном API. Мова дакументацыі і загаловак Accept-Language не змяняюць яго; руская выкарыстоўваецца, калі карыстацкая мова не канфігуруецца.

RUМясцовасць карыстальніка ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
BEБеларуская (be)
{
  "error": "error_brand_already_exists",
  "localMessage": "Брэнд Base ужо існуе",
  "params": {
    "name": "Base"
  }
}

Канчатковыя пункты

Канчатковыя пункты

GET

Знайсці вытворца па пазнацы

/api/manufacturer/{manufacturerId}
Значок з чытальным доступам

Атрымаць вытворца па ID з дапамогай GET /api/manufacturer/{manufacturerId}.

Параметры шляху

ПолеТыпАбавязковаАпісанне
manufacturerId integer · int32 Так Ід вытворцы.
curl --request GET 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў Manufacturer
ПолеТыпАбавязковаАпісанне
manufacturerId integer · int32 Не Ід вытворцы.
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑

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 Так Ід вытворцы.

Запытвальны орган

application/json
Палі аб'ектаўManufacturer
ПолеТыпАбавязковаАпісанне
manufacturerId integer · int32 Не Ід вытворцы.
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 Не Ід вытворцы.
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑

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 Так Ід вытворцы.

Параметры запытаў

ПолеТыпАбавязковаАпісанне
deleted boolean Так Здарэнне.
curl --request DELETE 'https://api.selsup.ru/api/manufacturer/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
"string"
Памылкі3

Памылкі прыкладання звычайна вяртаюцца ў выглядзе JSON з error, localMessage і params. Як вяртаюць памылкі прыкладання ↑

401auth_required
Патрабаваная аўтэнтыфікацыя

Authorization не хапае, пусты, або ўтрымлівае недаступны токен.

400error_access_denied
Доступ забаронены

Токен існуе, але яго роля не можа выканаць гэтую аперацыю.

500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі

Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.

POST

Стварэнне вытворцы

/api/manufacturer
Знак з пісьмовым доступам

Стварэнне вытворцы з дапамогай POST /api/manufacturer.

Запытвальны орган

application/json
Палі аб'ектаўManufacturer
ПолеТыпАбавязковаАпісанне
manufacturerId integer · int32 Не Ід вытворцы.
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 Не Ід вытворцы.
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑

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 Не Ід вытворцы.
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, localMessage і params. Як вяртаюць памылкі прыкладання ↑

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

Знак для запытаў на выпрабаванне

Токен застаецца ў лакальным сховішчы гэтага браўзэра і адпраўляецца толькі ў заголоўцы Authorization запытаў на api.selsup.ru.

Паспрабаваць

Рэальныя параметры запыту

Жывы адказ API

Пашляце запыт, каб убачыць адказ SelSup.