SelSup Developers

API · API Đề xuất

Các đối thủ cạnh tranh

Các điểm cuối cho các đối thủ cạnh tranh, 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 quy trình đáp ứng có thể mở rộng.

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

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 các đối thủ cạnh tranh

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.

Competitor6 trường
idinteger · int64

Id.

read-only
modelIdinteger · int64

- Thẻ mẫu.

servicestring

Dịch vụ.

Bắt buộc
urlstring

Url.

Bắt buộc
serviceIdstring

Đơn vị dịch vụ.

clientIdinteger · int64

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

read-only

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

Cập nhật

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

Cập nhật sử dụng PUT /api/competitor/{competitorId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
competitorId integer · int64 - Thẻ đối thủ.

Cơ quan yêu cầu

application/json
Các trường đối tượngCompetitor
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
modelId integer · int64 Không - Thẻ mẫu.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Dịch vụ.
url string Url.
serviceId string Không Đơn vị dịch vụ.
clientId integer · int64 Không - Đồ nhận khách hàng.
curl --request PUT 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Phản ứng thành công

200

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

Hầm lẫn8

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_competitor_id_required
Yêu cầu id đối thủ

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

400error_competitor_required
Phải có đối thủ

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

400error_competitor_service_required
Phải có dịch vụ đối thủ

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

400error_competitor_url_required
Phải có URL đối thủ

error cụ thể cho điểm cuối. Sử dụng mã error_competitor_url_required ổ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.

DELETE

Xóa

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

Xóa bằng cách sử dụng DELETE /api/competitor/{competitorId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
competitorId integer · int64 - Thẻ đối thủ.
curl --request DELETE 'https://api.selsup.ru/api/competitor/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_competitor_id_required
Yêu cầu id đối thủ

error cụ thể cho điểm cuối. Sử dụng mã error_competitor_id_required ổ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

Nhận tất cả

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

Nhận tất cả bằng cách sử dụng GET /api/competitor/{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/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN'

Phản ứng thành công

200
Cấu trúc của mục array Competitor[]
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
modelId integer · int64 Không - Thẻ mẫu.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Dịch vụ.
url string Url.
serviceId string Không Đơn vị dịch vụ.
clientId integer · int64 Không - Đồ nhận khách hàng.
[
  "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_model_id_required
Yêu cầu id mô hình

error cụ thể cho điểm cuối. Sử dụng mã error_model_id_required ổ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.

POST

Tạo

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

Tạo bằng POST /api/competitor/{modelId}.

Các tham số đường

TrườngLoạiBắt buộcMô tả
modelId integer · int64 - Thẻ mẫu.

Cơ quan yêu cầu

application/json
Các trường đối tượngCompetitor
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
modelId integer · int64 Không - Thẻ mẫu.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Dịch vụ.
url string Url.
serviceId string Không Đơn vị dịch vụ.
clientId integer · int64 Không - Đồ nhận khách hàng.
curl --request POST 'https://api.selsup.ru/api/competitor/1001' \
  --header 'Authorization: YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "clientId": 1001
}'

Phản ứng thành công

200
Các trường đối tượng Competitor
TrườngLoạiBắt buộcMô tả
id integer · int64 Không Id.
modelId integer · int64 Không - Thẻ mẫu.
service stringNONE, WILDBERRIES, OZON, YANDEX_MARKET, FAMILIYA, NATIONAL_CATALOG, ALIEXPRESS, OTHER, MOY_SKLAD, SBER_MEGA_MARKET, CISLINK, ONE_C, AVITO, LEROY_MERLIN, DETMIR, KAZAN_EXPRESS, EVOTOR, WEBASYST, AMAZON, EBAY, SIMALAND, INSALES, LAMODA, OZON_PERFORMANCE, WALMART, GOOGLE, YANDEX_DISC, EMAIL, WOOCOMMERCE, MAGNIT, OPENCART, M_VIDEO, TAKEALOT, UZUM, SHOPIFY, MAKRO, YANDEX_KIT, BOB_SHOP, KASPI, DIADOC Dịch vụ.
url string Url.
serviceId string Không Đơn vị dịch vụ.
clientId integer · int64 Không - Đồ nhận khách hàng.
{
  "service": "NONE",
  "url": "https://example.com",
  "id": 1001,
  "modelId": 1001,
  "serviceId": "string",
  "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_competitor_required
Phải có đối thủ

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

400error_competitor_service_required
Phải có dịch vụ đối thủ

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

400error_competitor_url_required
Phải có URL đối thủ

error cụ thể cho điểm cuối. Sử dụng mã error_competitor_url_required ổ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.

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.