Мадэлі пералічаныя тут адзін раз і могуць быць пашыраныя непасрэдна з канчатковых пунктаў, якія іх выкарыстоўваюць.
Competitor6 палёў
idinteger · int64
Id.
read-only
modelIdinteger · int64
Мадэль ID.
servicestring
Паслуга.
Абавязкова
urlstring
Ураль.
Абавязкова
serviceIdstring
Паслуга ID.
clientIdinteger · int64
Ідэнтыфікатар кліента.
read-only
Памылка дагавор
Як вяртаюць памылкі прыкладання
Код 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"
}
}
Канчатковыя пункты
Канчатковыя пункты
PUT
Абноўленне
/api/competitor/{competitorId}
Знак з пісьмовым доступам
Абноўленне з дапамогай PUT /api/competitor/{competitorId}.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_competitor_id_required
Патрабуецца id канкурэнта
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_competitor_required
Канкурэнт абавязковы
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_competitor_service_required
Сэрвіс канкурэнта абавязковы
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_service_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_competitor_url_required
Спасылка канкурэнта абавязковая
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_url_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
DELETE
Выдаліць
/api/competitor/{competitorId}
Знак з пісьмовым доступам
Выміраць з дапамогай DELETE /api/competitor/{competitorId}.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_competitor_id_required
Патрабуецца id канкурэнта
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
GET
Знайдзіце ўсё
/api/competitor/{modelId}
Значок з чытальным доступам
Атрымаць усё з дапамогай GET /api/competitor/{modelId}.
Параметры шляху
Поле
Тып
Абавязкова
Апісанне
modelId
integer · int64
Так
Мадэль ID.
curl --request GET 'https://api.selsup.ru/api/competitor/1001' \
--header 'Authorization: YOUR_API_TOKEN'
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_model_id_required
Патрабуецца id мадэлі
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_model_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
POST
Стварэнне
/api/competitor/{modelId}
Знак з пісьмовым доступам
Стварэнне з дапамогай POST /api/competitor/{modelId}.
Authorization не хапае, пусты, або ўтрымлівае недаступны токен.
400error_access_denied
Доступ забаронены
Токен існуе, але яго роля не можа выканаць гэтую аперацыю.
500error_unknown
Адбылася невядомая памылка. Калі праблема паўторыцца, напішыце ў службу падтрымкі
Унутраная няўдачы. Зэканоміць час запыту і кантактную падтрымку; не прабуйце зноў сляпыя мутацыі.
400error_competitor_required
Канкурэнт абавязковы
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_competitor_service_required
Сэрвіс канкурэнта абавязковы
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_service_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_competitor_url_required
Спасылка канкурэнта абавязковая
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_competitor_url_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.
400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку
Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.