Các cơ bản tích hợp · Các hướng dẫn
Bắt đầu
Truyền xác thực, yêu cầu đầu tiên, lỗi địa phương, trang, và một triển khai sản xuất an toàn.
Bắt đầu với một token chuyên dụng và một hoạt động đọc. Thêm đột biến chỉ sau khi xử lý error và thử lại hành vi đã được thử nghiệm.
Các nhà phát triển và tích hợp nền tảng01
Truyền xác thực và lưu trữ token
Gửi mã thông báo API trực tiếp vào tiêu đề Authorization mà không có tiền tố Bearer.
Tạo một token riêng cho mỗi tích hợp. Sau đó bạn có thể hủy bỏ một kết nối mà không gián đoạn những người khác và chỉ cấp các quyền cần thiết.
Cung cấp mã thông báo trong bí mật bên máy chủ. Đừng bao giờ gửi nó trong trình duyệt JavaScript, ứng dụng di động, URL, nhật ký hoặc phân tích.
Không thêm Bearer hoặc Basic. Giá trị Authorization là biểu tượng SelSup chính nó.
curl --request GET 'https://api.selsup.ru/api/brand/find?limit=50&page=1' \
--header 'Authorization: YOUR_API_TOKEN'
Các điểm cuối API liên quan
GET/api/brand/findyêu cầu thử nghiệm an toàn
02
Hình lỗi và địa điểm tin nhắn
Nhánh vào trường error ổn định và sử dụng localMessage chỉ cho đầu ra có thể đọc được bởi con người.
Một ứng dụng error thường chứa error, localMessage và params.
Ngôn ngữ tài liệu và Accept-Language không thay đổi địa điểm error. Đừng bao giờ so sánh localMessage trong mã hoặc duy trì nó như là trạng thái máy.
Tải lại trạng thái HTTP, error, params, thời gian yêu cầu và ID tương quan của bạn. Đừng ghi thẻ hoặc dữ liệu cá nhân.
{
"error": "brand_already_exists",
"localMessage": "Brand Base already exists",
"params": {
"name": "Base"
}
}
03
Trang web của các bộ sưu tập lớn
Sử dụng phân loại ổn định và dừng khi hasNextPage là sai hoặc trang trả lại ngắn hơn giới hạn.
count=true có thể kích hoạt một truy vấn đếm bổ sung. gửi nó trên yêu cầu đầu tiên chỉ khi tổng thực sự cần thiết.
Dữ liệu có thể thay đổi giữa các trang. Để đồng bộ hóa lặp đi lặp lại, sắp xếp theo một nhận dạng không thay đổi và thay đổi quá trình trong một dòng tăng trưởng riêng biệt.
let page = 1;
let hasNextPage = true;
while (hasNextPage) {
const url = new URL('https://api.selsup.ru/api/brand/find');
url.searchParams.set('limit', '500');
url.searchParams.set('page', String(page));
url.searchParams.set('sortBy', 'BRANDID');
url.searchParams.set('ascending', 'true');
const response = await fetch(url, {
headers: { Authorization: process.env.SELSUP_API_TOKEN }
});
if (!response.ok) throw await response.json();
const result = await response.json();
await savePage(result.rows);
hasNextPage = result.hasNextPage;
page += 1;
}
Các điểm cuối API liên quan
GET/api/brand/findVí dụ tìm kiếm trangGET/api/product/findTìm kiếm sản phẩm
04
Danh sách kiểm tra sản xuất
- 1
Đọc và viết riêng biệt
Hãy xác nhận yêu cầu GET trước. Sử dụng các thực thể thử nghiệm và một bước xác nhận rõ ràng cho đột biến.
- 2
Thiết lập thời gian và thử lại
Chỉ thử lỗi mạng và hoạt động an toàn. POST mà không có khóa vô hiệu hóa của riêng bạn có thể tạo ra một bản sao.
- 3
Giới hạn đồng thời
Hãy tôn trọng giới hạn điểm cuối và sử dụng một hàng với sự vứt vứt theo hàm số và một sự rắc rối ngẫu nhiên nhỏ.
- 4
Kết quả hòa giải
Sau khi đồng bộ hóa hàng loạt, so sánh số lượng và các định danh mẫu, sau đó di chuyển sự khác biệt vào một hàng riêng biệt.
Thử nó gửi yêu cầu đến tài khoản của chủ sở hữu token. Tài liệu thêm một xác nhận cho viết, nhưng bạn vẫn nên sử dụng hồ sơ thử nghiệm.