SelSup Developers

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

Маркіроўкі прадукту

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

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

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

/api/tag

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

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

01

Пачніце выкарыстоўваць тэгі прадукту

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

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

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

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

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

ProductTag3 палёў
idinteger · int64

Id.

read-only
namestring

Назва.

Абавязкова
clientIdinteger · int64

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

read-only
FindResponseProductTag1 палёў
rowsProductTag[]

Рыжкі.

FindResponseProductTagInfo1 палёў
rowsProductTagInfo[]

Рыжкі.

ProductTagInfo2 палёў
productIdinteger · int64

Ід прадукту.

productTagsProductTag[]

Тэгі прадукту.

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

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

Код 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/tag/{tagId}
Знак з пісьмовым доступам

Абноўленне Тэга з дапамогай PUT /api/tag/{tagId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.

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

application/json
Палі аб'ектаўProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
curl --request PUT 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Удалы адказ

200
Палі аб'ектаў ProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Памылкі7

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

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

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

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

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

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

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

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_id_and_name_required
Патрабуюцца id і імя тэга

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_id_and_name_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_id_required
Патрабуецца id тэга

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_update_failed
Не атрымалася абнавіць тэг з id: {0}

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_update_failed ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

DELETE

Абноўленне Тэга 1

/api/tag/{tagId}
Знак з пісьмовым доступам

Абноўленне таг 1 з дапамогай DELETE /api/tag/{tagId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі3

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

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

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

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

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

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

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

PUT

Звязаць тэг да прадукту

/api/tag/product/{tagId}/{productId}
Знак з пісьмовым доступам

Звязаць таг да прадукту з дапамогай PUT /api/tag/product/{tagId}/{productId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.
productId integer · int64 Так Ід прадукту.
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі6

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

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

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

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

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

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

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

400error_duplicate_tag_association
Тэг ужо прывязаны да прадукту

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_duplicate_tag_association ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_and_product_id_required
патрабуецца тэг і ID прадукту

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_and_product_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

DELETE

Un звязаць тэг да прадукту

/api/tag/product/{tagId}/{productId}
Знак з пісьмовым доступам

Un Bind Тэг Да прадукту з дапамогай DELETE /api/tag/product/{tagId}/{productId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.
productId integer · int64 Так Ід прадукту.
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі5

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

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

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

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

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

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

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

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_and_model_id_required
Патрабуюцца id тэга і id мадэлі

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_and_model_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

PUT

Звязаць тэг да мадэлі

/api/tag/model/{tagId}/{modelId}
Знак з пісьмовым доступам

Звязаць таг да мадэлі з дапамогай PUT /api/tag/model/{tagId}/{modelId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.
modelId integer · int64 Так Мадэль ID.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі6

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

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

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

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

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

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

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

400error_duplicate_tag_association
Тэг ужо прывязаны да прадукту

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_duplicate_tag_association ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_and_model_id_required
Патрабуюцца id тэга і id мадэлі

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_and_model_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

DELETE

Un звязаць тэг да мадэлі

/api/tag/model/{tagId}/{modelId}
Знак з пісьмовым доступам

Un Bind Тэг Для мадэлі з дапамогай DELETE /api/tag/model/{tagId}/{modelId}.

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

ПолеТыпАбавязковаАпісанне
tagId integer · int64 Так Пазначыць ID.
modelId integer · int64 Так Мадэль ID.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

Адказ не мае цела.

Памылкі5

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

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

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

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

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

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

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

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_and_model_id_required
Патрабуюцца id тэга і id мадэлі

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_and_model_id_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

POST

Стварэнне тэгу

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

Стварэнне тэгу з дапамогай POST /api/tag.

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

application/json
Палі аб'ектаўProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
curl --request POST 'https://api.selsup.ru/api/tag' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Удалы адказ

200
Палі аб'ектаў ProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Памылкі6

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

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

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

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

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

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

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

400error_duplicate_tag_name
Тэг з такім імем ужо існуе: {0}

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_duplicate_tag_name ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

400error_tag_name_required
Патрабуецца імя тэга

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_tag_name_required ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Знайсці тэгі

/api/tag/find
Значок з чытальным доступам

Знайсці тэгі з дапамогай GET /api/tag/find.

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

ПолеТыпАбавязковаАпісанне
query string Не Запытваючы.
productId integer · int64 Не Ід прадукту.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringID, NAME Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/tag/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseProductTag
ПолеТыпАбавязковаАпісанне
rows ProductTag[] Не Рыжкі.
Структура элементаў масіва ProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
{
  "rows": "string"
}
Памылкі4

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

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

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

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

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

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

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

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

GET

Знайсці тэгі ўзору

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

Знайсці тэгі мадэлі з дапамогай GET /api/tag/find/{modelId}.

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

ПолеТыпАбавязковаАпісанне
modelId integer · int64 Так Мадэль ID.
curl --request GET 'https://api.selsup.ru/api/tag/find/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseProductTagInfo
ПолеТыпАбавязковаАпісанне
rows ProductTagInfo[] Не Рыжкі.
Структура элементаў масіва ProductTagInfo
ПолеТыпАбавязковаАпісанне
productId integer · int64 Не Ід прадукту.
productTags ProductTag[] Не Тэгі прадукту.
Структура элементаў масіва ProductTag
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Так Назва.
clientId integer · int64 Не Ідэнтыфікатар кліента.
{
  "rows": "string"
}
Памылкі4

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

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

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

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

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

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

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

400error_no_client
Кліент не знойдзены або быў выдалены. Напішыце ў падтрымку

Спецыфічны для канчатковага пункту error. Выкарыстоўвайце стабільны код error_no_client ў лагіцы прыкладання; localMessage змяшчае пераклад, паказаны вышэй.

Authorization

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

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

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

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

Жывы адказ API

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