SelSup Developers

Public API · API Referencja

Wydatki

Punkty końcowe fakturowania, w tym dokładne trasy, parametry, organy żądania i rozszerzalne schematy odpowiedzi.

1 punkty końcowe/api/billing/findStabilnyOpis czytelny maszynowo ↗
{ }

Strona ta jest wspierana przez edytowalny samodzielny kontrakt.

/api/billing/find

Gotowe do użytkowania przepływy robocze

Gotowe do użytkowania przepływy robocze

01

Zacznij używać fakturowania

Użyj dedykowanego tokena API i najpierw sprawdź operacje odczytu z danymi testowymi.

  1. Trzymaj token z serwera i wysłać go w nagłówku Authorization.
  2. Sprawdź wymagane parametry i poszerz schemat żądania lub odpowiedzi.
  3. Zrób z statusem HTTP i stabilnym pole error w przypadku błędów aplikacyjnych.

Model danych

Struktura danych

Modele są wymienione tutaj raz i mogą być również rozszerzane bezpośrednio z punktów końcowych, które je wykorzystują.

Billing17 pola
idinteger · int64

Id.

namestring

- Nazwa.

productIdinteger · int64

Id produktu.

itemIdinteger · int64

Id. przedmiotu.

orderIdinteger · int64

Identyfikacja zamówienia.

pricenumber · double

- Cena.

volumeinteger · int32

- Głos.

weightinteger · int32

Waga.

quantityinteger · int32

- W ilości.

totalPricenumber · double

Całkowita cena.

tariffIdinteger · int64

Idemcyjną.

linkedClientIdinteger · int64

Związany identyfikator klienta.

clientIdinteger · int64

Id klientów.

fromstring · date-time

Od.

tostring · date-time

- Do.

datestring · date-time

- Spotkanie.

userIdinteger · int64

Id użytkownika.

FindResponseBilling1 pola
rowsBilling[]

Rzędy.

Umowa o błędzie

W jaki sposób można zwrócić błędy w aplikacji

Kod error jest identyczny w każdym miejscu, podczas gdy wiadomość skierowana do użytkownika jest tłumaczona przez serwer.

error

Stabilny kod czytelny maszynowo do logiki integracyjnej.

localMessage

Przesłanie gotowe do wyświetlania w języku użytkownika tokenu API.

params

Wartości interpołowane przez serwer w szablonie lokalizowanej wiadomości.

localMessage wykorzystuje pole lang użytkownika, który posiada token API. Język dokumentacji i nagłówek Accept-Language nie zmieniają go; rosyjski jest używany, gdy użytkujący nie ma konfigurowanego języka.

RULokalizacja użytkownika jest ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
PLPolski (pl)
{
  "error": "error_brand_already_exists",
  "localMessage": "Marka Base już istnieje",
  "params": {
    "name": "Base"
  }
}

Punkty końcowe

Punkty końcowe

GET

/Zajmij operację rachunku

/api/billing/find
Token z dostępem do odczytu

Uzyskaj operację rachunku za pomocą GET /api/billing/find.

Parametry zapytania

PoleTypWymaganeOpis
from string · date-time Nie Od.
to string · date-time Nie - Do.
limit integer · int32 Nie Ogranicz.
page integer · int32 Nie Strona.
count boolean Nie Zgromadzisz.
sortBy string Nie - Zarejestrowany.
ascending boolean Nie Wzniesienie.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Odpowiedź udana

200
Połączenia obiektu FindResponseBilling
PoleTypWymaganeOpis
rows Billing[] Nie Rzędy.
Struktura pozycji zestawu Billing
PoleTypWymaganeOpis
id integer · int64 Nie Id.
name string Nie - Nazwa.
productId integer · int64 Nie Id produktu.
itemId integer · int64 Nie Id. przedmiotu.
orderId integer · int64 Nie Identyfikacja zamówienia.
price number · double Nie - Cena.
volume integer · int32 Nie - Głos.
weight integer · int32 Nie Waga.
quantity integer · int32 Nie - W ilości.
totalPrice number · double Nie Całkowita cena.
tariffId integer · int64 Nie Idemcyjną.
linkedClientId integer · int64 Nie Związany identyfikator klienta.
clientId integer · int64 Nie Id klientów.
from string · date-time Nie Od.
to string · date-time Nie - Do.
date string · date-time Nie - Spotkanie.
userId integer · int64 Nie Id użytkownika.
{
  "rows": "string"
}
Władze5

błędy aplikacyjne są zwykle zwrócone jako JSON w error, localMessage i params. Oddział na error; tekst lokalizowany może się zmienić. W jaki sposób można zwrócić błędy w aplikacji ↑

401auth_required
Wymagane uwierzytelnianie

Authorization brakuje, jest puste lub zawiera nieważny token.

400error_access_denied
Dostęp zabroniony

Token istnieje, ale jego rola nie może wykonywać tej operacji.

500error_unknown
Wystąpił nieznany błąd. Jeśli problem się powtórzy, napisz do służby wsparcia

Nie próbuj ponownie mutacji.

400error_no_client
Klient nie znaleziony lub został usunięty. Napisz do wsparcia

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_no_client; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

400error_subscription_expired
Twój okres obowiązywania taryfy wygasł. Opłać taryfę, aby kontynuować korzystanie z serwisu.

error specyficzny dla punktu końcowego. W logice aplikacji użyj stabilnego kodu error_subscription_expired; XPRO TECTED2X zawiera tłumaczenie przedstawione powyżej.

Authorization

Token do wniosków o badania

Token pozostaje w lokalnym magazynie przeglądarki i jest wysyłany tylko w nagłówku Authorization z wniosków na api.selsup.ru.

Wypróbuj

Prawdziwe parametry żądania

Odpowiedź API

Wyślij wniosek o zapoznanie się z odpowiedzią SelSup.