SelSup Developers

Halk API · API İpucu

Faturada

Bilinme için son noktalar, tam yollar, parametreler, talep organları ve genişletilenebilir cevap skemleri dahil olmak üzere.

1 Son noktaları/api/billing/findDayanıklıMakine okuyabilir açıklama ↗
{ }

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

/api/billing/find

Kullanılabilir iş akışları

Kullanılabilir iş akışları

01

Faturayı 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.

Billing17 alanlar
idinteger · int64

Id.

namestring

Adı.

productIdinteger · int64

Ürün Kimliği.

itemIdinteger · int64

- İdeal kimliği.

orderIdinteger · int64

- Sipariş kimliği.

pricenumber · double

- Fiyat.

volumeinteger · int32

- Hacim.

weightinteger · int32

Ağırlık.

quantityinteger · int32

- Çok.

totalPricenumber · double

Toplam fiyat.

tariffIdinteger · int64

Tarif kimliği.

linkedClientIdinteger · int64

Bağlı müşteri kimliği.

clientIdinteger · int64

Müşteri kimliği.

fromstring · date-time

- Evet.

tostring · date-time

- Evet.

datestring · date-time

- Randevu.

userIdinteger · int64

Kullanıcı Kimliği.

FindResponseBilling1 alanlar
rowsBilling[]

- Sırada.

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

Faturayı Yap

/api/billing/find
Okuma erişimi olan işaret

GET /api/billing/find. kullanarak fatura işlemini yapın

Sorgulama parametreleri

AlanTürZorunluAçıklama
from string · date-time Hayır - Evet.
to string · date-time Hayır - Evet.
limit integer · int32 Hayır Sınır.
page integer · int32 Hayır Sayfa.
count boolean Hayır Sayın Sayın.
sortBy string Hayır - Yürü.
ascending boolean Hayır Yukarı çıkıyorum.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Başarılı tepki

200
Nesne alanları FindResponseBilling
AlanTürZorunluAçıklama
rows Billing[] Hayır - Sırada.
Array öğesi yapısı Billing
AlanTürZorunluAçıklama
id integer · int64 Hayır Id.
name string Hayır Adı.
productId integer · int64 Hayır Ürün Kimliği.
itemId integer · int64 Hayır - İdeal kimliği.
orderId integer · int64 Hayır - Sipariş kimliği.
price number · double Hayır - Fiyat.
volume integer · int32 Hayır - Hacim.
weight integer · int32 Hayır Ağırlık.
quantity integer · int32 Hayır - Çok.
totalPrice number · double Hayır Toplam fiyat.
tariffId integer · int64 Hayır Tarif kimliği.
linkedClientId integer · int64 Hayır Bağlı müşteri kimliği.
clientId integer · int64 Hayır Müşteri kimliği.
from string · date-time Hayır - Evet.
to string · date-time Hayır - Evet.
date string · date-time Hayır - Randevu.
userId integer · int64 Hayır Kullanıcı Kimliği.
{
  "rows": "string"
}
Hatalar5

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.

400error_no_client
Müşteri bulunamadı veya silinmiş. Destek birimine yazın

Uygulama mantığında sabit error_no_client kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

400error_subscription_expired
Tarife süreniz doldu. Hizmeti kullanmaya devam etmek için tarifeyi ödeyin.

Uygulama mantığında sabit error_subscription_expired kodu kullanın; localMessage yukarıda gösterilen çevirileri içerir.

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.