SelSup Developers

API · API Đề xuất

Quản đơn

Các điểm cuối cho nhậ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.

4 điểm cuối/api/receiptThườ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/receipt

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 Quý phiếu

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.

Receipt14 trường
idinteger · int64

Id.

read-only
clientIdinteger · int64

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

read-only
orderIdinteger · int64

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

read-only
organizationIdinteger · int64

Đơn vị tổ chức.

read-only
externalReceiptIdstring

Đơn nhận bên ngoài

fiscalNumberstring

Số tài chính.

cashRegisterServicestring

Dịch vụ ghi tiền mặt.

fnsUrlstring

Fns Url.

statusstring

Status.

receiptTypestring

Tiểu biên nhận.

totalAmountnumber · double

Tổng số tiền.

createdDatestring · date-time

Ngày được tạo ra.

read-only
completedDatestring · date-time

Ngày hoàn thành.

errorMessagestring

Thông báo lỗi.

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

Nhận biên lai theo đơn đặt hàng

/api/receipt/order/{orderId}
Tấm mã với truy cập đọc

Nhận biên lai theo đơn đặt hàng bằng cách sử dụng GET /api/receipt/order/{orderId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
orderId integer · int64 Đơn vị nhận dạng.
curl --request GET 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Cấu trúc của mục array Receipt[]
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
clientId integer · int64 Không - Đồ nhận khách hàng.
orderId integer · int64 Không Đơn vị nhận dạng.
organizationId integer · int64 Không Đơn vị tổ chức.
externalReceiptId string Không Đơn nhận bên ngoài
fiscalNumber string Không Số tài chính.
cashRegisterService stringNONE, EVOTOR, ATOL Không Dịch vụ ghi tiền mặt.
fnsUrl string Không Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Không Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Không Tiểu biên nhận.
totalAmount number · double Không Tổng số tiền.
createdDate string · date-time Không Ngày được tạo ra.
completedDate string · date-time Không Ngày hoàn thành.
errorMessage string Không Thông báo lỗi.
[
  "string"
]
Hầm lẫn3

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.

POST

Tạo biên bản để đặt hàng

/api/receipt/order/{orderId}
Tấm mã với quyền truy cập viết

Tạo biên bản để đặt hàng bằng cách sử dụng POST /api/receipt/order/{orderId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
orderId integer · int64 Đơn vị nhận dạng.

Các tham số truy vấn

TrườngLoạiBắt buộcMô tả
typeGiá trị mặc định: INCOME stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Không Type.
curl --request POST 'https://api.selsup.ru/api/receipt/order/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng Receipt
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
clientId integer · int64 Không - Đồ nhận khách hàng.
orderId integer · int64 Không Đơn vị nhận dạng.
organizationId integer · int64 Không Đơn vị tổ chức.
externalReceiptId string Không Đơn nhận bên ngoài
fiscalNumber string Không Số tài chính.
cashRegisterService stringNONE, EVOTOR, ATOL Không Dịch vụ ghi tiền mặt.
fnsUrl string Không Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Không Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Không Tiểu biên nhận.
totalAmount number · double Không Tổng số tiền.
createdDate string · date-time Không Ngày được tạo ra.
completedDate string · date-time Không Ngày hoàn thành.
errorMessage string Không Thông báo lỗi.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hầm lẫn3

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.

GET

Nhận biên bản

/api/receipt/{receiptId}
Tấm mã với truy cập đọc

Nhận Quí đơn bằng cách sử dụng GET /api/receipt/{receiptId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
receiptId integer · int64 Đồ nhận.
curl --request GET 'https://api.selsup.ru/api/receipt/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng Receipt
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
clientId integer · int64 Không - Đồ nhận khách hàng.
orderId integer · int64 Không Đơn vị nhận dạng.
organizationId integer · int64 Không Đơn vị tổ chức.
externalReceiptId string Không Đơn nhận bên ngoài
fiscalNumber string Không Số tài chính.
cashRegisterService stringNONE, EVOTOR, ATOL Không Dịch vụ ghi tiền mặt.
fnsUrl string Không Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Không Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Không Tiểu biên nhận.
totalAmount number · double Không Tổng số tiền.
createdDate string · date-time Không Ngày được tạo ra.
completedDate string · date-time Không Ngày hoàn thành.
errorMessage string Không Thông báo lỗi.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hầm lẫn3

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.

GET

Cập nhật trạng thái nhận

/api/receipt/{receiptId}/update
Tấm mã với truy cập đọc

Cập nhật trạng thái nhận bằng GET /api/receipt/{receiptId}/update.

Các tham số đường

TrườngLoạiBắt buộcMô tả
receiptId integer · int64 Đồ nhận.
curl --request GET 'https://api.selsup.ru/api/receipt/1001/update' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng Receipt
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
clientId integer · int64 Không - Đồ nhận khách hàng.
orderId integer · int64 Không Đơn vị nhận dạng.
organizationId integer · int64 Không Đơn vị tổ chức.
externalReceiptId string Không Đơn nhận bên ngoài
fiscalNumber string Không Số tài chính.
cashRegisterService stringNONE, EVOTOR, ATOL Không Dịch vụ ghi tiền mặt.
fnsUrl string Không Fns Url.
status stringCREATED, PENDING, COMPLETED, FAILED, CANCELLED Không Status.
receiptType stringINCOME, EXPENSE, REFUND, EXPENSE_REFUND Không Tiểu biên nhận.
totalAmount number · double Không Tổng số tiền.
createdDate string · date-time Không Ngày được tạo ra.
completedDate string · date-time Không Ngày hoàn thành.
errorMessage string Không Thông báo lỗi.
{
  "id": 1001,
  "clientId": 1001,
  "orderId": 1001,
  "organizationId": 1001,
  "externalReceiptId": "string",
  "fiscalNumber": "string"
}
Hầm lẫn3

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.

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.