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.
Keyword3 trường
idinteger · int64
Id.
namestring
Tên.
usingQuantityinteger · int32
Sử dụng Quantity.
KeywordGroup3 trường
idinteger · int64
Id.
namestring
Tên.
keywordsKeyword[]
Từ khóa.
KeywordAndGroup2 trường
keywordKeyword[]
Từ khóa.
groupKeywordGroup[]
Nhó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
GET
Tìm từ khóa từ nhóm
/api/keyword/group/{groupId}
Tấm mã với truy cập đọc
Nhận từ khóa từ nhóm bằng cách sử dụng GET /api/keyword/group/{groupId}.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
groupId
integer · int64
Có
Nhóm nhận dạng.
curl --request GET 'https://api.selsup.ru/api/keyword/group/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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
Edit Keyword Group By Id
/api/keyword/group/{groupId}
Tấm mã với quyền truy cập viết
chỉnh sửa Từ khóa Nhóm theo ID bằng cách sử dụng PUT /api/keyword/group/{groupId}.
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.
DELETE
Xóa nhóm từ khóa
/api/keyword/group/{groupId}
Tấm mã với quyền truy cập viết
Xóa nhóm từ khóa bằng cách sử dụng DELETE /api/keyword/group/{groupId}.
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.
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
Tìm nhóm từ khóa
/api/keyword/group
Tấm mã với truy cập đọc
Nhận Nhóm từ khóa bằng cách sử dụng GET /api/keyword/group.
curl --request GET 'https://api.selsup.ru/api/keyword/group' \
--header 'Authorization: YOUR_API_TOKEN'
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.
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.
DELETE
Xóa nhóm từ khóa
/api/keyword/group
Tấm mã với quyền truy cập viết
Xóa nhóm từ khóa bằng cách sử dụng DELETE /api/keyword/group.
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
Thêm vào nhóm từ khóa
/api/keyword/group/merge
Tấm mã với quyền truy cập viết
Thêm lại các nhóm từ khóa sử dụng POST /api/keyword/group/merge.
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_group_name
Tên của nhóm từ khóa không thể trống
error cụ thể cho điểm cuối. Sử dụng mã error_empty_group_name ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
400error_empty_keywords_groups
Nhóm từ khóa trống
error cụ thể cho điểm cuối. Sử dụng mã error_empty_keywords_groups ổn định trong logic ứng dụng; localMessage chứa phiên bản được hiển thị ở trên.
400error_need_at_least_two_groups
cần ít nhất hai nhóm
error cụ thể cho điểm cuối. Sử dụng mã error_need_at_least_two_groups ổ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.
GET
Tìm từ khóa cho thực thể
/api/keyword/{modelId}
Tấm mã với truy cập đọc
Nhận từ khóa cho Entity bằng cách sử dụng GET /api/keyword/{modelId}.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
modelId
integer · int64
Có
- Thẻ mẫu.
curl --request GET 'https://api.selsup.ru/api/keyword/1001' \
--header 'Authorization: YOUR_API_TOKEN'
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
Tìm nhóm từ khóa
/api/keyword/group/find
Tấm mã với truy cập đọc
Tìm Nhóm từ khóa bằng cách sử dụng GET /api/keyword/group/find.
Các tham số truy vấn
Trường
Loại
Bắt buộc
Mô tả
word
string
Có
- Nói đi.
curl --request GET 'https://api.selsup.ru/api/keyword/group/find?word=string' \
--header 'Authorization: YOUR_API_TOKEN'
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.
DELETE
Xóa nhóm từ khóa từ Entity
/api/keyword/model/{modelId}
Tấm mã với quyền truy cập viết
Xóa nhóm từ khóa từ Entity bằng cách sử dụng DELETE /api/keyword/model/{modelId}.
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.
DELETE
Xóa từ khóa từ nhóm
/api/keyword/group/{groupId}/keywords
Tấm mã với quyền truy cập viết
Xóa từ khóa từ nhóm bằng cách sử dụng DELETE /api/keyword/group/{groupId}/keywords.
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.