SelSup Developers

API · API Đề xuất

Các nhãn sản phẩm

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

9 điểm cuối/api/tagThườ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/tag

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 thẻ sản phẩm

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.

ProductTag3 trường
idinteger · int64

Id.

read-only
namestring

Tên.

Bắt buộc
clientIdinteger · int64

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

read-only
FindResponseProductTag1 trường
rowsProductTag[]

Đường.

FindResponseProductTagInfo1 trường
rowsProductTagInfo[]

Đường.

ProductTagInfo2 trường
productIdinteger · int64

Đơn vị sản phẩm

productTagsProductTag[]

Các thẻ sản phẩm.

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

PUT

Tag cập nhật

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

Cập nhật Tag sử dụng PUT /api/tag/{tagId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.

Cơ quan yêu cầu

application/json
Các trường đối tượngProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
curl --request PUT 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Phản ứng thành công

200
Các trường đối tượng ProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
{
  "name": "Example",
  "id": 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_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_tag_id_and_name_required
Phải nhập id và tên thẻ

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

400error_tag_id_required
Phải nhập id thẻ

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

400error_tag_update_failed
Không thể cập nhật thẻ với id: {0}

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

DELETE

Tải lại Tag 1

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

Cập nhật Tag 1 bằng cách sử dụng DELETE /api/tag/{tagId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.
curl --request DELETE 'https://api.selsup.ru/api/tag/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200

Phản ứng không có cơ thể.

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.

PUT

Kết nối thẻ với sản phẩm

/api/tag/product/{tagId}/{productId}
Tấm mã với quyền truy cập viết

Kết nối thẻ với sản phẩm bằng cách sử dụng PUT /api/tag/product/{tagId}/{productId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.
productId integer · int64 Đơn vị sản phẩm
curl --request PUT 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200

Phản ứng không có cơ thể.

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_duplicate_tag_association
Thể đã được liên kẹt về sản phẩm.

error cụ thể cho điểm cuối. Sử dụng mã error_duplicate_tag_association ổ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_tag_and_product_id_required
yêu cầu thẻ và ID sản phẩm

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

DELETE

Un Bind Tag To Product

/api/tag/product/{tagId}/{productId}
Tấm mã với quyền truy cập viết

Un Bind Tag To Product sử dụng DELETE /api/tag/product/{tagId}/{productId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.
productId integer · int64 Đơn vị sản phẩm
curl --request DELETE 'https://api.selsup.ru/api/tag/product/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200

Phản ứng không có cơ thể.

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_tag_and_model_id_required
Phải nhập id thẻ và id sản phẩm

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

PUT

Kết nối thẻ với mô hình

/api/tag/model/{tagId}/{modelId}
Tấm mã với quyền truy cập viết

Kết nối Tag với mô hình sử dụng PUT /api/tag/model/{tagId}/{modelId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.
modelId integer · int64 - Thẻ mẫu.
curl --request PUT 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200

Phản ứng không có cơ thể.

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_duplicate_tag_association
Thể đã được liên kẹt về sản phẩm.

error cụ thể cho điểm cuối. Sử dụng mã error_duplicate_tag_association ổ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_tag_and_model_id_required
Phải nhập id thẻ và id sản phẩm

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

DELETE

Un Bind Tag To Model

/api/tag/model/{tagId}/{modelId}
Tấm mã với quyền truy cập viết

Un Bind Tag To Model sử dụng DELETE /api/tag/model/{tagId}/{modelId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
tagId integer · int64 Đánh dấu.
modelId integer · int64 - Thẻ mẫu.
curl --request DELETE 'https://api.selsup.ru/api/tag/model/1001/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200

Phản ứng không có cơ thể.

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_tag_and_model_id_required
Phải nhập id thẻ và id sản phẩm

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

POST

Tạo Tag

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

Tạo Tag bằng POST /api/tag.

Cơ quan yêu cầu

application/json
Các trường đối tượngProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
curl --request POST 'https://api.selsup.ru/api/tag' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "id": 1001,
  "clientId": 1001
}'

Phản ứng thành công

200
Các trường đối tượng ProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
{
  "name": "Example",
  "id": 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_duplicate_tag_name
Thẻ thẻ với tên này: {0}

error cụ thể cho điểm cuối. Sử dụng mã error_duplicate_tag_name ổ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_tag_name_required
Tên thẻ là bắt buộc

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

GET

Tìm Tags

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

Tìm Tags sử dụng GET /api/tag/find.

Các tham số truy vấn

TrườngLoạiBắt buộcMô tả
query string Không - Tôi hỏi.
productId integer · int64 Không Đơn vị sản phẩm
limit integer · int32 Không Giới hạn.
page integer · int32 Không Page.
count boolean Không - Anh đếm.
sortBy stringID, NAME Không Đặt hàng.
ascending boolean Không Tăng lên.
curl --request GET 'https://api.selsup.ru/api/tag/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 FindResponseProductTag
TrườngLoạiBắt buộcMô tả
rows ProductTag[] Không Đường.
Cấu trúc của mục array ProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
{
  "rows": "string"
}
Hầm lẫn4

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.

GET

Tìm thẻ mô hình

/api/tag/find/{modelId}
Tấm mã với truy cập đọc

Tìm các thẻ mô hình bằng cách sử dụng GET /api/tag/find/{modelId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
modelId integer · int64 - Thẻ mẫu.
curl --request GET 'https://api.selsup.ru/api/tag/find/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Các trường đối tượng FindResponseProductTagInfo
TrườngLoạiBắt buộcMô tả
rows ProductTagInfo[] Không Đường.
Cấu trúc của mục array ProductTagInfo
TrườngLoạiBắt buộcMô tả
productId integer · int64 Không Đơn vị sản phẩm
productTags ProductTag[] Không Các thẻ sản phẩm.
Cấu trúc của mục array ProductTag
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
name string Tên.
clientId integer · int64 Không - Đồ nhận khách hàng.
{
  "rows": "string"
}
Hầm lẫn4

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.

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.