SelSup Developers

API · API Đề xuất

Nhà sản xuất

Các điểm cuối cho các nhà sản xuất, 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 ứng có thể mở rộng.

5 điểm cuối/api/manufacturerThườ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/manufacturer

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 Nhà sản xuất

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.

Manufacturer11 trường
manufacturerIdinteger · int32

Đơn vị sản xuất

titlestring

Tiêu đề.

namestring

Tên.

Bắt buộc
addressstring

Địa chỉ.

organizationIdinteger · int64

Đơn vị tổ chức.

clientIdinteger · int64

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

read-only
countryIdinteger · int32

Đơn vị quốc gia.

countryNamestring

Tên quốc gia.

read-only
innstring

Nhà nghỉ.

deletedboolean

- Quá xóa.

oneCIdstring

Một nhân viên.

FindResponseManufacturer1 trường
rowsManufacturer[]

Đườ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

Tìm nhà sản xuất theo ID

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

Tìm kiếm Nhà sản xuất theo ID sử dụng GET /api/manufacturer/{manufacturerId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Đơn vị sản xuất
curl --request GET 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng Manufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Hầm lẫn6

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_manufacturer_not_found
Không tìm thấy nhà sản xuất: {id}

error cụ thể cho điểm cuối. Sử dụng mã error_manufacturer_not_found ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trê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.

PUT

Tạm dịch:

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

Cập nhật Nhà sản xuất sử dụng PUT /api/manufacturer/{manufacturerId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
manufacturerId integer · int64 Đơn vị sản xuất

Cơ quan yêu cầu

application/json
Các trường đối tượngManufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
curl --request PUT 'https://api.selsup.ru/api/manufacturer/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Phản ứng thành công

200
Các trường đối tượng Manufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Hầm lẫn7

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_empty_manufacturer_name
Tên nhà sản xuất không được chỉ định

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

400error_manufacturer_already_exist
Đã có nhà sản xuất tên là {name}

error cụ thể cho điểm cuối. Sử dụng mã error_manufacturer_already_exist ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trê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.

DELETE

Tắt nhà sản xuất

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

Xóa Nhà sản xuất sử dụng DELETE /api/manufacturer/{manufacturerId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Đơn vị sản xuất

Các tham số truy vấn

TrườngLoạiBắt buộcMô tả
deleted boolean - Quá xóa.
curl --request DELETE 'https://api.selsup.ru/api/manufacturer/1001?deleted=false' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
"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 nhà sản xuất

/api/manufacturer
Tấm mã với quyền truy cập viết

Tạo Nhà sản xuất sử dụng POST /api/manufacturer.

Cơ quan yêu cầu

application/json
Các trường đối tượngManufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
curl --request POST 'https://api.selsup.ru/api/manufacturer' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}'

Phản ứng thành công

200
Các trường đối tượng Manufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
{
  "name": "Example",
  "manufacturerId": 1001,
  "title": "Example",
  "address": "string",
  "organizationId": 1001,
  "clientId": 1001
}
Hầm lẫn7

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_empty_manufacturer_name
Tên nhà sản xuất không được chỉ định

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

400error_manufacturer_already_exist
Đã có nhà sản xuất tên là {name}

error cụ thể cho điểm cuối. Sử dụng mã error_manufacturer_already_exist ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trê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.

GET

Tìm ra

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

Tìm bằng cách sử dụng GET /api/manufacturer/find.

Các tham số truy vấn

TrườngLoạiBắt buộcMô tả
query string Không - Tôi hỏi.
manufacturerOneCId string Không Nhà sản xuất 1 CId.
limit integer · int32 Không Giới hạn.
page integer · int32 Không Page.
count boolean Không - Anh đếm.
sortBy stringMANUFACTURERID, NAME Không Đặt hàng.
ascending boolean Không Tăng lên.
curl --request GET 'https://api.selsup.ru/api/manufacturer/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 FindResponseManufacturer
TrườngLoạiBắt buộcMô tả
rows Manufacturer[] Không Đường.
Cấu trúc của mục array Manufacturer
TrườngLoạiBắt buộcMô tả
manufacturerId integer · int32 Không Đơn vị sản xuất
title string Không Tiêu đề.
name string Tên.
address string Không Địa chỉ.
organizationId integer · int64 Không Đơn vị tổ chức.
clientId integer · int64 Không - Đồ nhận khách hàng.
countryId integer · int32 Không Đơn vị quốc gia.
countryName string Không Tên quốc gia.
inn string Không Nhà nghỉ.
deleted boolean Không - Quá xóa.
oneCId string Không Một nhân viên.
{
  "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.