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-ді көрсету үшін ғана пайдалану.

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

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

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

PUT

Жаңарту тегі

/api/tag/{tagId}
Жазуға қол жеткізуге мүмкіндік беретін белгі

PUT /api/tag/{tagId}. қолдана отырып тег жаңарту

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

ӨрісТүріМіндеттіСипаттама
tagId integer · int64 Иә Таг идентификаторы.

Өтініш органы

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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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}
Жазуға қол жеткізуге мүмкіндік беретін белгі

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 Иә Өнімнің идентификаторы.
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
Тег өнімге бұрыннан байланған

Аяқ нүктесі 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

Өнімге тегтерді байлау

/api/tag/product/{tagId}/{productId}
Жазуға қол жеткізуге мүмкіндік беретін белгі

DELETE /api/tag/product/{tagId}/{productId}. арқылы өнімге тегіні байлау

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

ӨрісТүріМіндеттіСипаттама
tagId integer · int64 Иә Таг идентификаторы.
productId integer · int64 Иә Өнімнің идентификаторы.
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
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі 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 Иә Таг идентификаторы.
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
Тег өнімге бұрыннан байланған

Аяқ нүктесі 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

Үлгіге байланысты белгі

/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
Клиент табылмады немесе жойылды. Қолдау қызметіне жазыңыз

Аяқ нүктесі 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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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 Иә Үлгілік идентификаторы.
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 және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

401auth_required
Құжатты куәландыру қажет

Authorization жоқ, бос немесе жарамсыз белгісі бар.

400error_access_denied
Қолжетімділікке тыйым салынған

Токен бар, бірақ оның рөлі бұл операцияны орындай алмайды.

500error_unknown
Белгісіз қате орын алды. Егер мәселе қайталанса, қолдау қызметіне жазыңыз

Ішкі қате. Сұраныс уақытын және байланыс қолдауын үнемдеу; көзге көрінбейтін түрде қайта сынап көріңіз.

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

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

Authorization

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

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

Байқап көру

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

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

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