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

Продукт ID.

itemIdinteger · int64

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

orderIdinteger · int64

Түзөтүү ID.

pricenumber · double

Баасы.

volumeinteger · int32

Топтоо.

weightinteger · int32

Салмагы.

quantityinteger · int32

- Канчалык?

totalPricenumber · double

Толук баа.

tariffIdinteger · int64

Тарифтик идентификация.

linkedClientIdinteger · int64

Колдонуучунун идентификатору.

clientIdinteger · int64

Кардар ID.

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"
  }
}
KYКыргызча (ky)
{
  "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 Жок Продукт ID.
itemId integer · int64 Жок Теманын идентификатору.
orderId integer · int64 Жок Түзөтүү ID.
price number · double Жок Баасы.
volume integer · int32 Жок Топтоо.
weight integer · int32 Жок Салмагы.
quantity integer · int32 Жок - Канчалык?
totalPrice number · double Жок Толук баа.
tariffId integer · int64 Жок Тарифтик идентификация.
linkedClientId integer · int64 Жок Колдонуучунун идентификатору.
clientId integer · int64 Жок Кардар ID.
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
Клиент не найден или был удален. Напишите в поддержку

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

400error_subscription_expired
Тарифиңиздин мөөнөтү бүттү. Кызматты колдонууну улантуу үчүн тарифти төлөңүз.

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

Authorization

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

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

Байкап көрүү

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

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

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