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

Кардар ID.

read-only
FindResponseProductTag1 аймактар
rowsProductTag[]

Саптар.

FindResponseProductTagInfo1 аймактар
rowsProductTagInfo[]

Саптар.

ProductTagInfo2 аймактар
productIdinteger · int64

Продукт ID.

productTagsProductTag[]

Продукциянын белгилери.

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

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

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

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

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

PUT

Жаңыртуу теги

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

PUT /api/tag/{tagId}. колдонгон Тегиңизди жаңыртуу

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.

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

application/json
Объекттердин талааларыProductTag
ТалааТүрүМилдеттүүСүрөттөмө
id integer · int64 Жок Id.
name string Ооба Аты.
clientId integer · int64 Жок Кардар ID.
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 Жок Кардар ID.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Каталар7

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

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

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

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

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

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

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

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

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

400error_tag_id_and_name_required
Тегдин id жана аты талап кылынат

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

400error_tag_id_required
Тегтин IDси талап кылынат

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

400error_tag_update_failed
id: {0} менен тегди жаңыртуу мүмкүн болгон жок

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

DELETE

1-таг жаңыландыруу

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

DELETE /api/tag/{tagId}. менен 1 белгини жаңыртуу

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

Бул жооптун денеси жок.

Каталар3

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

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

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

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

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

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

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

PUT

Продукцияга тегиңизди байлаңыз

/api/tag/product/{tagId}/{productId}
Жазуу мүмкүнчүлүгү бар белги

PUT /api/tag/product/{tagId}/{productId}. колдонгон продуктка тегиңизди байлаңыз

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.
productId integer · int64 Ооба Продукт ID.
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

Бул жооптун денеси жок.

Каталар6

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

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

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

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

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

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

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

400error_duplicate_tag_association
Тег продуктка мурунтан эле байланган

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

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

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

400error_tag_and_product_id_required
тег жана продукт IDси талап кылынат

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

DELETE

Продукцияга шилтеме бербе

/api/tag/product/{tagId}/{productId}
Жазуу мүмкүнчүлүгү бар белги

DELETE /api/tag/product/{tagId}/{productId}. колдонгон продуктка шилтеме бер

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.
productId integer · int64 Ооба Продукт ID.
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

Бул жооптун денеси жок.

Каталар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_tag_and_model_id_required
Тегтин id жана модельдин id талап кылынат

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

PUT

Модельге тегиңизди байлаңыз

/api/tag/model/{tagId}/{modelId}
Жазуу мүмкүнчүлүгү бар белги

PUT /api/tag/model/{tagId}/{modelId}. колдонгон моделге тегиңизди байлаңыз

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.
modelId integer · int64 Ооба Макеттик идентификация.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

Бул жооптун денеси жок.

Каталар6

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

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

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

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

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

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

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

400error_duplicate_tag_association
Тег продуктка мурунтан эле байланган

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

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

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

400error_tag_and_model_id_required
Тегтин id жана модельдин id талап кылынат

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

DELETE

Модельге байлоо

/api/tag/model/{tagId}/{modelId}
Жазуу мүмкүнчүлүгү бар белги

DELETE /api/tag/model/{tagId}/{modelId}. колдонгон моделге байлоо белгиси

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

ТалааТүрүМилдеттүүСүрөттөмө
tagId integer · int64 Ооба Тагдырдын идентификациясы.
modelId integer · int64 Ооба Макеттик идентификация.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200

Бул жооптун денеси жок.

Каталар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_tag_and_model_id_required
Тегтин id жана модельдин id талап кылынат

Endpoint-specific 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 Жок Кардар ID.
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 Жок Кардар ID.
{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}
Каталар6

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

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

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

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

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

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

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

400error_duplicate_tag_name
Мындай аталыштагы тег мурунтан эле бар: {0}

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

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

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

400error_tag_name_required
Тег аты талап кылынат

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

GET

Тегдерди табуу

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

GET /api/tag/find. колдонгон белгилерди табуу

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

ТалааТүрүМилдеттүүСүрөттөмө
query string Жок Суроо.
productId integer · int64 Жок Продукт ID.
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 Жок Кардар ID.
{
  "rows": "string"
}
Каталар4

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

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

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

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

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

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

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

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

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

GET

Үлгү белгилерин табуу

/api/tag/find/{modelId}
Окуу мүмкүнчүлүгү бар белги

GET /api/tag/find/{modelId}. колдонгон моделдик белгилерди табуу

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

ТалааТүрүМилдеттүүСүрөттөмө
modelId integer · int64 Ооба Макеттик идентификация.
curl --request GET 'https://api.selsup.ru/api/tag/find/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

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

200
Объекттердин талаалары FindResponseProductTagInfo
ТалааТүрүМилдеттүүСүрөттөмө
rows ProductTagInfo[] Жок Саптар.
Топтун элементтеринин түзүлүшү ProductTagInfo
ТалааТүрүМилдеттүүСүрөттөмө
productId integer · int64 Жок Продукт ID.
productTags ProductTag[] Жок Продукциянын белгилери.
Топтун элементтеринин түзүлүшү ProductTag
ТалааТүрүМилдеттүүСүрөттөмө
id integer · int64 Жок Id.
name string Ооба Аты.
clientId integer · int64 Жок Кардар ID.
{
  "rows": "string"
}
Каталар4

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

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

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

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

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

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

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

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

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

Authorization

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

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

Байкап көрүү

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

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

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