SelSup Developers

API · API Ma'lumotnoma

Rasm

Qutqarish uchun yakuniy nuqtalar, shu jumladan aniq yo'nalishlar, parametrlar, so'rov organlari va kengaytiriladigan javob sxemalari.

4 yakuniy nuqtalar/api/receiptTurg'unMashina o'qiladigan tavsif ↗
{ }

Ushbu sahifani tahrirlash mumkin bo'lgan mustaqil shartnoma bilan ta'minlaydi. Ishlab chiqarishdan oldin sinov ma'lumotlari bilan yozish operatsiyalarini tasdiqlash.

/api/receipt

Ishga tayyor ish oqimlari

Ishga tayyor ish oqimlari

Ma'lumotlar modeli

Ma'lumotlar tuzilmalari

Modellari bu yerda bir marta ro'yxatga olingan va ularni ishlatadigan oxirgi nuqtalardan to'g'ridan-to'gʻri kengaytirilishi mumkin.

Receipt14 maydonlar
idinteger · int64

Id.

read-only
clientIdinteger · int64

Mijozning identifikatori.

read-only
orderIdinteger · int64

Buyurtma guvohnomasi.

read-only
organizationIdinteger · int64

Tashkilot identifikatori.

read-only
externalReceiptIdstring

Tashqi rasim guvohnomasi.

fiscalNumberstring

Moliyaviy raqam.

cashRegisterServicestring

Pul qayd xizmati.

fnsUrlstring

Fns Url.

statusstring

Status.

receiptTypestring

Rasm turi.

totalAmountnumber · double

Jami miqdor.

createdDatestring · date-time

Tanlangan kun.

read-only
completedDatestring · date-time

To'liq tugallangan sana.

errorMessagestring

Xato xabarlari.

Xato shartnomasi

Ilovalar xatolarini qaytarib berish usuli

error kodlari har bir joyda bir xil, foydalanuvchiga qaratilgan xabar server tomonidan tarjima qilinadi. error atrofida dastur mantiqasini quring va localMessage-dan faqat ko'rsatish uchun foydalaning.

error

Integratsiya mantiqasini yaratish uchun barqaror mashina o'qiladigan kod.

localMessage

API token foydalanuvchisining tilida ko'rsatishga tayyor xabar.

params

Server tomonidan mahalliylashtirilgan xabar namunalariga interpolatsiya qilingan qiymatlar.

localMessage API tokenini egallagan foydalanuvchining lang maydoni ishlatiladi. Hujjat tili va Accept-Language boshliq uni o'zgartirmaydi; foydalanuvchi tilni moslamasa rus tilida ishlatiladigan.

RUFoydalanuvchi manzili ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
UZOʻzbekcha (uz)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base brendi allaqachon mavjud",
  "params": {
    "name": "Base"
  }
}

Keyingi nuqtalar

Keyingi nuqtalar

GET

Qayd etishdan keyin rasmga olish

/api/receipt/order/{orderId}
Oʻqish imkoniyatiga ega token

GET /api/receipt/order/{orderId}. yordamida buyurtma orqali rasm olish

Yo'l parametrlari

MaydonTurMajburiyTavsif
orderId integer · int64 Ha Buyurtma guvohnomasi.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Array elementining tuzilishi Receipt[]
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
clientId integer · int64 Yoʻq Mijozning identifikatori.
orderId integer · int64 Yoʻq Buyurtma guvohnomasi.
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
externalReceiptId string Yoʻq Tashqi rasim guvohnomasi.
fiscalNumber string Yoʻq Moliyaviy raqam.
cashRegisterService stringNONE, EVOTOR, ATOL Yoʻq Pul qayd xizmati.
fnsUrl string Yoʻq Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Yoʻq Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Yoʻq Rasm turi.
totalAmount number · double Yoʻq Jami miqdor.
createdDate string · date-time Yoʻq Tanlangan kun.
completedDate string · date-time Yoʻq To'liq tugallangan sana.
errorMessage string Yoʻq Xato xabarlari.
[
  "string"
]
Xatolar3

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

POST

Buyurtma uchun rasmga ega boʻling

/api/receipt/order/{orderId}
Yozib olish imkoniyatiga ega token

POST /api/receipt/order/{orderId}. yordamida buyurtma uchun rasmga ega boʻling

Yo'l parametrlari

MaydonTurMajburiyTavsif
orderId integer · int64 Ha Buyurtma guvohnomasi.

Soʻrov parametrlari

MaydonTurMajburiyTavsif
typeStandart qiymat: INCOME stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Yoʻq Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Ob'ekt maydonlari Receipt
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
clientId integer · int64 Yoʻq Mijozning identifikatori.
orderId integer · int64 Yoʻq Buyurtma guvohnomasi.
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
externalReceiptId string Yoʻq Tashqi rasim guvohnomasi.
fiscalNumber string Yoʻq Moliyaviy raqam.
cashRegisterService stringNONE, EVOTOR, ATOL Yoʻq Pul qayd xizmati.
fnsUrl string Yoʻq Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Yoʻq Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Yoʻq Rasm turi.
totalAmount number · double Yoʻq Jami miqdor.
createdDate string · date-time Yoʻq Tanlangan kun.
completedDate string · date-time Yoʻq To'liq tugallangan sana.
errorMessage string Yoʻq Xato xabarlari.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Xatolar3

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

GET

Rasm olish

/api/receipt/{receiptId}
Oʻqish imkoniyatiga ega token

GET /api/receipt/{receiptId}. yordamida rasmga ega boʻling

Yo'l parametrlari

MaydonTurMajburiyTavsif
receiptId integer · int64 Ha Rasm guvohnomasi.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Ob'ekt maydonlari Receipt
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
clientId integer · int64 Yoʻq Mijozning identifikatori.
orderId integer · int64 Yoʻq Buyurtma guvohnomasi.
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
externalReceiptId string Yoʻq Tashqi rasim guvohnomasi.
fiscalNumber string Yoʻq Moliyaviy raqam.
cashRegisterService stringNONE, EVOTOR, ATOL Yoʻq Pul qayd xizmati.
fnsUrl string Yoʻq Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Yoʻq Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Yoʻq Rasm turi.
totalAmount number · double Yoʻq Jami miqdor.
createdDate string · date-time Yoʻq Tanlangan kun.
completedDate string · date-time Yoʻq To'liq tugallangan sana.
errorMessage string Yoʻq Xato xabarlari.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Xatolar3

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

GET

Qildiruv holatini yangilash

/api/receipt/{receiptId}/update
Oʻqish imkoniyatiga ega token

GET /api/receipt/{receiptId}/update. yordamida Qutlugʻ Kechlik holati

Yo'l parametrlari

MaydonTurMajburiyTavsif
receiptId integer · int64 Ha Rasm guvohnomasi.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Muvaffaqiyatli javob

200
Ob'ekt maydonlari Receipt
MaydonTurMajburiyTavsif
id integer · int64 Yoʻq Id.
clientId integer · int64 Yoʻq Mijozning identifikatori.
orderId integer · int64 Yoʻq Buyurtma guvohnomasi.
organizationId integer · int64 Yoʻq Tashkilot identifikatori.
externalReceiptId string Yoʻq Tashqi rasim guvohnomasi.
fiscalNumber string Yoʻq Moliyaviy raqam.
cashRegisterService stringNONE, EVOTOR, ATOL Yoʻq Pul qayd xizmati.
fnsUrl string Yoʻq Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Yoʻq Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Yoʻq Rasm turi.
totalAmount number · double Yoʻq Jami miqdor.
createdDate string · date-time Yoʻq Tanlangan kun.
completedDate string · date-time Yoʻq To'liq tugallangan sana.
errorMessage string Yoʻq Xato xabarlari.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Xatolar3

Dastur xatolari error, localMessage va params bilan JSON sifatida qaytarilgan. XPROTextning XPRO TECTED4X-ga bo'linishi; mahalliylashtirilgan matn o'zgarishi mumkin. Ilovalar xatolarini qaytarib berish usuli ↑

401auth_required
Tasdiqlash talab etiladi

Authorization yo'qolgan, bo'sh yoki haqiqiy bo'lmagan tokenni o'z ichiga oladi.

400error_access_denied
Kirish taqiqlangan

Token mavjud, ammo uning roli ushbu operatsiyani amalga oshirolmaydi.

500error_unknown
Noma'lum xatolik yuz berdi. Agar muammo takrorlansa, qo'llab-quvvatlash xizmatiga yozing

Ichki xato. So'rov vaqtini va aloqalarni saqlab qoling; mutatsiyani ko'r bo'lib qayta sinab ko'ring.

Authorization

Sinov talablari uchun belgisi

Token ushbu brauzerning localStorage-da qoladi va faqat api.selsup.ru nomli so'rovlarning Authorization boshliqida yuboriladi.

Sinab koʻrish

Haqiqiy talab parametrlari

API- ning jonli javoblari

SelSup javobini ko'rish uchun iltimos yuboring.