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

Нысан ID.

orderIdinteger · int64

Өзімнің жеке куәлігім.

pricenumber · double

Баға.

volumeinteger · int32

Толық.

weightinteger · int32

Салмағы.

quantityinteger · int32

Кісілік.

totalPricenumber · double

Тоталь баға.

tariffIdinteger · int64

Тарифтік идентификаторы.

linkedClientIdinteger · int64

Клиенттің жеке басын тіркеу.

clientIdinteger · int64

Клиент танымдығы.

fromstring · date-time

- Менен.

tostring · date-time

Олай болса.

datestring · date-time

Кездесу.

userIdinteger · int64

Пайдаланушы ID.

FindResponseBilling1 өрістер
rowsBilling[]

Сызықтар.

Қате туралы келісімшарт

Қолданба қателерін қайтару

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

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

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

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 Жоқ Нысан ID.
orderId integer · int64 Жоқ Өзімнің жеке куәлігім.
price number · double Жоқ Баға.
volume integer · int32 Жоқ Толық.
weight integer · int32 Жоқ Салмағы.
quantity integer · int32 Жоқ Кісілік.
totalPrice number · double Жоқ Тоталь баға.
tariffId integer · int64 Жоқ Тарифтік идентификаторы.
linkedClientId integer · int64 Жоқ Клиенттің жеке басын тіркеу.
clientId integer · int64 Жоқ Клиент танымдығы.
from string · date-time Жоқ - Менен.
to string · date-time Жоқ Олай болса.
date string · date-time Жоқ Кездесу.
userId integer · int64 Жоқ Пайдаланушы ID.
{
  "rows": "string"
}
Қателер5

Қолданба қателері JSON, error және params-пен JSON ретінде қайтарылады. error-ке тармақ; жергілікті мәтін өзгеруі мүмкін. Қолданба қателерін қайтару ↑

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

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

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

Байқап көру

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

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

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