SelSup Developers

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

Выпрабаванне гіпотэзы

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

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

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

/api/hypothesis

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

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

01

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

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

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

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

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

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

Hypothesis14 палёў
idinteger · int32

Id.

namestring

Назва.

previousStartDatestring · date-time

Папярэдняя дата пачатку.

startDatestring · date-time

Пачатак дата.

endDatestring · date-time

Завяршальная дата.

modelIdinteger · int64

Мадэль ID.

modelArticlestring

Мадэль артыкула.

viewIdinteger · int64

Паглядзіце ID.

productIdinteger · int64

Ід прадукту.

organizationIdinteger · int64

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

createdDatestring · date-time

Стварыўся Дата.

createdUserstring

Створаны карыстальнік.

servicestring

Паслуга.

successStatusstring

Статус поспеху.

FindResponseHypothesis1 палёў
rowsHypothesis[]

Рыжкі.

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

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

Код 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"
  }
}

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

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

POST

Гіпатэзы

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

Гіпатэза з выкарыстаннем POST /api/hypothesis/.

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

application/json
Палі аб'ектаўHypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
curl --request POST 'https://api.selsup.ru/api/hypothesis/' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "previousStartDate": "2026-01-15T12:00:00Z",
  "startDate": "2026-01-15T12:00:00Z",
  "endDate": "2026-01-15T12:00:00Z",
  "modelId": 1001
}'

Удалы адказ

200
Палі аб'ектаў Hypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
{
  "id": 1001,
  "name": "Example",
  "previousStartDate": "2026-01-15T12:00:00Z",
  "startDate": "2026-01-15T12:00:00Z",
  "endDate": "2026-01-15T12:00:00Z",
  "modelId": 1001
}
Памылкі8

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

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

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

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

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

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

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

400error_empty_end_date
Не пазначана дата заканчэння

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

400error_empty_name
Не пазначана назва

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

400error_empty_start_date
Не указана дата начала

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

400error_end_less_then_start_date
Дата заканчэння павінна быць большай за дату пачатку

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

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

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

GET

Ід

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

ID з выкарыстаннем GET /api/hypothesis/{id}.

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

ПолеТыпАбавязковаАпісанне
id integer · int32 Так Id.
curl --request GET 'https://api.selsup.ru/api/hypothesis/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў Hypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
{
  "id": 1001,
  "name": "Example",
  "previousStartDate": "2026-01-15T12:00:00Z",
  "startDate": "2026-01-15T12:00:00Z",
  "endDate": "2026-01-15T12:00:00Z",
  "modelId": 1001
}
Памылкі4

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

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

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

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

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

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

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

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

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

PATCH

Гіпатэза патча

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

Гіпатэза патча з выкарыстаннем PATCH /api/hypothesis/{id}.

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

application/json
Палі аб'ектаўHypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
curl --request PATCH 'https://api.selsup.ru/api/hypothesis/%7Bid%7D' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1001,
  "name": "Example",
  "previousStartDate": "2026-01-15T12:00:00Z",
  "startDate": "2026-01-15T12:00:00Z",
  "endDate": "2026-01-15T12:00:00Z",
  "modelId": 1001
}'

Удалы адказ

200
Палі аб'ектаў Hypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
{
  "id": 1001,
  "name": "Example",
  "previousStartDate": "2026-01-15T12:00:00Z",
  "startDate": "2026-01-15T12:00:00Z",
  "endDate": "2026-01-15T12:00:00Z",
  "modelId": 1001
}
Памылкі9

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

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

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

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

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

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

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

400error_empty_end_date
Не пазначана дата заканчэння

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

400error_empty_id
Не пазначаны ідэнтыфікатар

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

400error_empty_name
Не пазначана назва

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

400error_empty_start_date
Не указана дата начала

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

400error_end_less_then_start_date
Дата заканчэння павінна быць большай за дату пачатку

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

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

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

DELETE

Знішчыць гіпотэзу

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

Знішчыць гіпотэзу з дапамогай DELETE /api/hypothesis/{id}.

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

ПолеТыпАбавязковаАпісанне
id integer · int32 Так Id.
curl --request DELETE 'https://api.selsup.ru/api/hypothesis/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200

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

Памылкі4

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

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

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

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

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

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

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

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

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

GET

Знайсці

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

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

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

ПолеТыпАбавязковаАпісанне
query string Не Запытваючы.
modelId integer · int64 Не Мадэль ID.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
endDateFrom string · date-time Не Дата заканчэння ад.
endDateTo string · date-time Не Да канца да.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy stringID, NAME, CREATEDDATE, CREATEDUSER, STARTDATE, ENDDATE, PREVIOUSSTARTDATE, SUCCESSSTATUS Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/hypothesis/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseHypothesis
ПолеТыпАбавязковаАпісанне
rows Hypothesis[] Не Рыжкі.
Структура элементаў масіва Hypothesis
ПолеТыпАбавязковаАпісанне
id integer · int32 Не Id.
name string Не Назва.
previousStartDate string · date-time Не Папярэдняя дата пачатку.
startDate string · date-time Не Пачатак дата.
endDate string · date-time Не Завяршальная дата.
modelId integer · int64 Не Мадэль ID.
modelArticle string Не Мадэль артыкула.
viewId integer · int64 Не Паглядзіце ID.
productId integer · int64 Не Ід прадукту.
organizationId integer · int64 Не Ід арганізацыі.
createdDate string · date-time Не Стварыўся Дата.
createdUser string Не Створаны карыстальнік.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Не Паслуга.
successStatus stringNONE, SUCCESSFUL, UNSUCCESSFUL Не Статус поспеху.
{
  "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.