SelSup Developers

Halk API · API İpucu

Kayıt

Tam yollar, parametreler, talep organları ve genişletilebilir cevap sistemleri dahil olmak üzere Alışveriş için son noktalar.

4 Son noktaları/api/receiptDayanıklıMakine okuyabilir açıklama ↗
{ }

Bu sayfa düzenlenebilir bir bağımsız sözleşme ile desteklenir.

/api/receipt

Kullanılabilir iş akışları

Kullanılabilir iş akışları

01

Kitsayı kullanmaya başlayın

Özel bir API token kullanın ve önce test verileri ile okuma işlemlerini doğrulayın.

  1. Token sunucu tarafında tut ve Authorization başlığı gönder.
  2. Gerekli parametreleri kontrol edin ve istek veya yanıt şeması genişletin.
  3. Uygulama hatalarında HTTP durumunu ve sabit error alanını ele alın.

Verim modeli

Veriler yapısı

Modeller burada bir kez listelenmiştir ve bunları kullanan uç noktalardan doğrudan genişletilebilir.

Receipt14 alanlar
idinteger · int64

Id.

read-only
clientIdinteger · int64

Müşteri kimliği.

read-only
orderIdinteger · int64

- Sipariş kimliği.

read-only
organizationIdinteger · int64

Teşkilat Kimliği.

read-only
externalReceiptIdstring

Dış Kitset Kimliği.

fiscalNumberstring

Vergi numarası.

cashRegisterServicestring

Nakit Kayıt Hizmetleri.

fnsUrlstring

- Fns Url.

statusstring

Status.

receiptTypestring

- Kits tip.

totalAmountnumber · double

Toplam miktar.

createdDatestring · date-time

Tarih yaratıldı.

read-only
completedDatestring · date-time

Tarih tamamlandı.

errorMessagestring

Hata Mesajı.

Hata sözleşmesi

Uygulama hataları nasıl iade edilir

error kodu her yerde aynıdır, kullanıcıya yönelik mesaj ise sunucu tarafından tercüme edilir. error etrafında uygulama mantığı oluşturun ve localMessage'i yalnızca görüntülemek için kullanın.

error

Entegre mantığı için sabit makine okunur kod.

localMessage

API token kullanıcısının dilinde görüntülemeye hazır mesaj.

params

Sunucu tarafından yerel mesaj şablonuna girilen değerler.

localMessage, API tokenine sahip olan kullanıcının lang alanını kullanır. Belgeleme dili ve Accept-Language başlığı değiştirmez; kullanıcıya dil yapılandırılmadığında Rusça kullanılır.

RUKullanıcı yerel ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
TRTürkçe (tr)
{
  "error": "error_brand_already_exists",
  "localMessage": "Base markası zaten mevcut",
  "params": {
    "name": "Base"
  }
}

Son noktaları

Son noktaları

GET

Bildirme Al

/api/receipt/order/{orderId}
Okuma erişimi olan işaret

GET /api/receipt/order/{orderId}. kullanarak siparişle Kits alın

Yol parametreleri

AlanTürZorunluAçıklama
orderId integer · int64 Evet - Sipariş kimliği.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Array öğesi yapısı Receipt[]
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
clientId integer · int64 Hayır Müşteri kimliği.
orderId integer · int64 Hayır - Sipariş kimliği.
organizationId integer · int64 Hayır Teşkilat Kimliği.
externalReceiptId string Hayır Dış Kitset Kimliği.
fiscalNumber string Hayır Vergi numarası.
cashRegisterService stringNONE, EVOTOR, ATOL Hayır Nakit Kayıt Hizmetleri.
fnsUrl string Hayır - Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Hayır Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Hayır - Kits tip.
totalAmount number · double Hayır Toplam miktar.
createdDate string · date-time Hayır Tarih yaratıldı.
completedDate string · date-time Hayır Tarih tamamlandı.
errorMessage string Hayır Hata Mesajı.
[
  "string"
]
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

POST

Sipariş için Belediye Oluştur

/api/receipt/order/{orderId}
Yazma erişimli işaretleme

POST /api/receipt/order/{orderId}. kullanarak sipariş için makbuz oluştur

Yol parametreleri

AlanTürZorunluAçıklama
orderId integer · int64 Evet - Sipariş kimliği.

Sorgulama parametreleri

AlanTürZorunluAçıklama
typeVarsayılan değer: INCOME stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Hayır Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları Receipt
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
clientId integer · int64 Hayır Müşteri kimliği.
orderId integer · int64 Hayır - Sipariş kimliği.
organizationId integer · int64 Hayır Teşkilat Kimliği.
externalReceiptId string Hayır Dış Kitset Kimliği.
fiscalNumber string Hayır Vergi numarası.
cashRegisterService stringNONE, EVOTOR, ATOL Hayır Nakit Kayıt Hizmetleri.
fnsUrl string Hayır - Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Hayır Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Hayır - Kits tip.
totalAmount number · double Hayır Toplam miktar.
createdDate string · date-time Hayır Tarih yaratıldı.
completedDate string · date-time Hayır Tarih tamamlandı.
errorMessage string Hayır Hata Mesajı.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

GET

Kvitanı Al

/api/receipt/{receiptId}
Okuma erişimi olan işaret

GET /api/receipt/{receiptId}. kullanarak Kits alın

Yol parametreleri

AlanTürZorunluAçıklama
receiptId integer · int64 Evet - Kits.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları Receipt
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
clientId integer · int64 Hayır Müşteri kimliği.
orderId integer · int64 Hayır - Sipariş kimliği.
organizationId integer · int64 Hayır Teşkilat Kimliği.
externalReceiptId string Hayır Dış Kitset Kimliği.
fiscalNumber string Hayır Vergi numarası.
cashRegisterService stringNONE, EVOTOR, ATOL Hayır Nakit Kayıt Hizmetleri.
fnsUrl string Hayır - Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Hayır Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Hayır - Kits tip.
totalAmount number · double Hayır Toplam miktar.
createdDate string · date-time Hayır Tarih yaratıldı.
completedDate string · date-time Hayır Tarih tamamlandı.
errorMessage string Hayır Hata Mesajı.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

GET

İlaç Durumu Güncelle

/api/receipt/{receiptId}/update
Okuma erişimi olan işaret

GET /api/receipt/{receiptId}/update. kullanarak İlaç Durumu güncelle

Yol parametreleri

AlanTürZorunluAçıklama
receiptId integer · int64 Evet - Kits.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları Receipt
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
clientId integer · int64 Hayır Müşteri kimliği.
orderId integer · int64 Hayır - Sipariş kimliği.
organizationId integer · int64 Hayır Teşkilat Kimliği.
externalReceiptId string Hayır Dış Kitset Kimliği.
fiscalNumber string Hayır Vergi numarası.
cashRegisterService stringNONE, EVOTOR, ATOL Hayır Nakit Kayıt Hizmetleri.
fnsUrl string Hayır - Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Hayır Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Hayır - Kits tip.
totalAmount number · double Hayır Toplam miktar.
createdDate string · date-time Hayır Tarih yaratıldı.
completedDate string · date-time Hayır Tarih tamamlandı.
errorMessage string Hayır Hata Mesajı.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hatalar3

Uygulama hataları error, localMessage ve params ile JSON olarak normalde iade edilir. error'e şubeler; yerel metin değişebilir. Uygulama hataları nasıl iade edilir ↑

401auth_required
Doğrulama Gerekli

Authorization eksik, boş veya geçersiz bir token içerir.

400error_access_denied
Erişim engellendi

Token var ama rolü bu işlemleri yapamaz.

500error_unknown
Bilinmeyen bir hata oluştu. Sorun tekrarlanırsa, destek birimine yazın

İç hata. İstek zamanını ve iletişim desteğini tasarruf et; mutasyonu körü körü görmeden tekrar deneme.

Authorization

Test istekleri için işaret

Token bu tarayıcı lokalStorage'da kalır ve sadece api.selsup.ru adresine Authorization başlığındaki isteklerde gönderilir.

Dene

Gerçek talep parametreleri

Canlı API tepkisi

SelSup cevabını görmek için bir istek gönderin.