SelSup Developers

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

Заліковае

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

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

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

/api/billing/find

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

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

01

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

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

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

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

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

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

Billing17 палёў
idinteger · int64

Id.

namestring

Назва.

productIdinteger · int64

Ід прадукту.

itemIdinteger · int64

Ід пастановы.

orderIdinteger · int64

Падпісанне па заказ.

pricenumber · double

Прэс.

volumeinteger · int32

Аб'ём.

weightinteger · int32

Вага.

quantityinteger · int32

Колькасць.

totalPricenumber · double

Агульны кошт.

tariffIdinteger · int64

Падатковы пазнак.

linkedClientIdinteger · int64

Звязаная ID кліента.

clientIdinteger · int64

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

fromstring · date-time

З.

tostring · date-time

Да.

datestring · date-time

Дата.

userIdinteger · int64

Пазнак карыстальніка.

FindResponseBilling1 палёў
rowsBilling[]

Рыжкі.

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

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

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

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

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

GET

Атрымаць аперацыю рахунку

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

Атрымаць аперацыю рахунку з дапамогай GET /api/billing/find.

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

ПолеТыпАбавязковаАпісанне
from string · date-time Не З.
to string · date-time Не Да.
limit integer · int32 Не Межа.
page integer · int32 Не Праз старонку.
count boolean Не Граф.
sortBy string Не Пасля.
ascending boolean Не Падыходзіць.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Удалы адказ

200
Палі аб'ектаў FindResponseBilling
ПолеТыпАбавязковаАпісанне
rows Billing[] Не Рыжкі.
Структура элементаў масіва Billing
ПолеТыпАбавязковаАпісанне
id integer · int64 Не Id.
name string Не Назва.
productId integer · int64 Не Ід прадукту.
itemId integer · int64 Не Ід пастановы.
orderId integer · int64 Не Падпісанне па заказ.
price number · double Не Прэс.
volume integer · int32 Не Аб'ём.
weight integer · int32 Не Вага.
quantity integer · int32 Не Колькасць.
totalPrice number · double Не Агульны кошт.
tariffId integer · int64 Не Падатковы пазнак.
linkedClientId integer · int64 Не Звязаная ID кліента.
clientId integer · int64 Не Ідэнтыфікатар кліента.
from string · date-time Не З.
to string · date-time Не Да.
date string · date-time Не Дата.
userId integer · int64 Не Пазнак карыстальніка.
{
  "rows": "string"
}
Памылкі5

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

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

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

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

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

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

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

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

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

400error_subscription_expired
У вас скончыўся тэрмін дзеяння тарыфа. Аплаціце тарыф для працягу выкарыстання сэрвісу.

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

Authorization

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

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

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

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

Жывы адказ API

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