SelSup Developers

API · API Đề xuất

Đánh giá

Các điểm cuối cho việc thanh toán, bao gồm các tuyến đường chính xác, các tham số, cơ quan yêu cầu và các chương trình phản hồi có thể mở rộng.

1 điểm cuối/api/billing/findThường ổn địnhMô tả có thể đọc được bằng máy ↗
{ }

Trang này được hỗ trợ bởi một hợp đồng độc lập có thể chỉnh sửa. Thiết lập các hoạt động viết bằng dữ liệu thử nghiệm trước khi sử dụng sản xuất.

/api/billing/find

Các dòng công việc sẵn sàng sử dụng

Các dòng công việc sẵn sàng sử dụng

01

Bắt đầu sử dụng Billing

Sử dụng mã thông báo API chuyên dụng và xác nhận các hoạt động đọc bằng dữ liệu thử nghiệm trước.

  1. Giữ token bên máy chủ và gửi nó trong tiêu đề Authorization.
  2. Kiểm tra các tham số cần thiết và mở rộng quy trình yêu cầu hoặc phản hồi.
  3. xử lý trạng thái HTTP và trường error ổn định trong lỗi ứng dụng.

Mô hình dữ liệu

Các cấu trúc dữ liệu

Các mô hình được liệt kê một lần ở đây và cũng có thể được mở rộng trực tiếp từ các điểm cuối sử dụng chúng.

Billing17 trường
idinteger · int64

Id.

namestring

Tên.

productIdinteger · int64

Đơn vị sản phẩm

itemIdinteger · int64

Đơn vị nhận dạng.

orderIdinteger · int64

Đơn vị nhận dạng.

pricenumber · double

Giá cả.

volumeinteger · int32

Tầm âm.

weightinteger · int32

- Chất nặng.

quantityinteger · int32

Số lượng.

totalPricenumber · double

Giá cả hoàn toàn.

tariffIdinteger · int64

Đơn vị thuế quan.

linkedClientIdinteger · int64

Đơn vị khách hàng liên kết.

clientIdinteger · int64

- Đồ nhận khách hàng.

fromstring · date-time

Từ.

tostring · date-time

Để.

datestring · date-time

Rồi hẹn hò.

userIdinteger · int64

ID người dùng.

FindResponseBilling1 trường
rowsBilling[]

Đường.

Hợp đồng lỗi

Cách trả lại lỗi ứng dụng

Mã error giống nhau ở mọi địa điểm, trong khi thông điệp đối diện người dùng được dịch bởi máy chủ. Xây dựng logic ứng dụng xung quanh error và sử dụng localMessage chỉ cho hiển thị.

error

Mã máy tính có thể đọc ổn định cho logic tích hợp.

localMessage

Thông điệp sẵn sàng hiển thị trong ngôn ngữ của người dùng mã thông báo API.

params

Các giá trị được máy chủ liên kết vào mẫu tin nhắn địa phương.

localMessage sử dụng trường lang của người dùng sở hữu mã thông báo API. Ngôn ngữ tài liệu và tiêu đề Accept-Language không thay đổi nó; tiếng Nga được sử dụng khi người dùng không có ngôn ngữ được cấu hình.

RUUser locale là ru
{
  "error": "error_brand_already_exists",
  "localMessage": "Бренд Base уже существует",
  "params": {
    "name": "Base"
  }
}
VNTiếng Việt (vn)
{
  "error": "error_brand_already_exists",
  "localMessage": "Thương hiệu Base đã tồn tại",
  "params": {
    "name": "Base"
  }
}

Điểm cuối

Điểm cuối

GET

Làm việc thanh toán

/api/billing/find
Tấm mã với truy cập đọc

Nhận hoạt động thanh toán bằng GET /api/billing/find.

Các tham số truy vấn

TrườngLoạiBắt buộcMô tả
from string · date-time Không Từ.
to string · date-time Không Để.
limit integer · int32 Không Giới hạn.
page integer · int32 Không Page.
count boolean Không - Anh đếm.
sortBy string Không Đặt hàng.
ascending boolean Không Tăng lên.
curl --request GET 'https://api.selsup.ru/api/billing/find?limit=50&page=1' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng FindResponseBilling
TrườngLoạiBắt buộcMô tả
rows Billing[] Không Đường.
Cấu trúc của mục array Billing
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Không Tên.
productId integer · int64 Không Đơn vị sản phẩm
itemId integer · int64 Không Đơn vị nhận dạng.
orderId integer · int64 Không Đơn vị nhận dạng.
price number · double Không Giá cả.
volume integer · int32 Không Tầm âm.
weight integer · int32 Không - Chất nặng.
quantity integer · int32 Không Số lượng.
totalPrice number · double Không Giá cả hoàn toàn.
tariffId integer · int64 Không Đơn vị thuế quan.
linkedClientId integer · int64 Không Đơn vị khách hàng liên kết.
clientId integer · int64 Không - Đồ nhận khách hàng.
from string · date-time Không Từ.
to string · date-time Không Để.
date string · date-time Không Rồi hẹn hò.
userId integer · int64 Không ID người dùng.
{
  "rows": "string"
}
Hầm lẫn5

Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑

401auth_required
Định nghĩa xác thực cần thiết

Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.

400error_access_denied
Truy cập bị từ chối

Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.

500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ

Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.

400error_no_client
Khách hàng không được tìm thấy hoặc đã bị xóa. Viết để hỗ trợ

error cụ thể cho điểm cuối. Sử dụng mã error_no_client ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.

400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.

error cụ thể cho điểm cuối. Sử dụng mã error_subscription_expired ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.

Authorization

Tỷ hiệu cho các yêu cầu thử nghiệm

Các token vẫn ở trong localStorage của trình duyệt này và chỉ được gửi trong tiêu đề Authorization của các yêu cầu đến api.selsup.ru.

Thử

Các tham số yêu cầu thực

Đáp lại API trực tiếp

Gửi yêu cầu để xem phản ứng SelSup.