Tài liệu API WEEX: Cách bắt đầu sử dụng API giao dịch WEEX

Để bắt đầu sử dụng API WEEX, bạn cần hai thứ: tài liệu API WEEX chính thức và API Key được cấu hình cho các chức năng bạn muốn dùng. WEEX cung cấp tài nguyên API cho giao dịch giao ngay và hợp đồng tương lai USDT-M, với tài liệu hướng dẫn về dữ liệu thị trường, chức năng tài khoản, thao tác giao dịch, REST API và kết nối WebSocket.

Nhà phát triển có thể truy cập các endpoint được hỗ trợ để lấy dữ liệu thị trường công khai mà không cần xác thực. Các chức năng riêng tư, bao gồm quản lý tài khoản và lệnh, yêu cầu API Key và các yêu cầu đã xác thực.

Quy trình thiết lập khá đơn giản: chọn tài liệu API WEEX phù hợp, tạo API Key, cấu hình các quyền cần thiết, bảo mật thông tin xác thực và kết nối ứng dụng với endpoint API tương ứng.

Bạn có thể tìm tài liệu API WEEX chính thức ở đâu?

WEEX duy trì tài liệu API riêng cho các sản phẩm và giao diện được hỗ trợ. Tài liệu được cập nhật khi tính năng API thay đổi, và trang của từng endpoint có ví dụ về yêu cầu và phản hồi để tích hợp. 

Đối với Spot V3, tài liệu đề cập đến quy trình chuẩn bị, tên miền API, xác thực, dữ liệu thị trường, chức năng tài khoản, chức năng lệnh, kết nối WebSocket, giới hạn tốc độ và các yêu cầu kỹ thuật khác.

WEEX chia API thành giao diện công khai và riêng tư. API công khai có thể truy xuất thông tin cấu hình và dữ liệu thị trường mà không cần xác thực. API riêng tư hỗ trợ các chức năng như quản lý lệnh và tài khoản, đồng thời yêu cầu các yêu cầu đã xác thực.

Trước khi tích hợp, nhà phát triển nên chọn tài liệu dành cho sản phẩm định sử dụng vì endpoint và yêu cầu kỹ thuật có thể khác nhau giữa giao dịch giao ngay và hợp đồng tương lai.

Cách tạo API Key WEEX

Để sử dụng các chức năng API riêng tư của WEEX, trước tiên bạn cần tạo API Key thông qua tài khoản WEEX của mình. Theo tài liệu Spot V3 hiện tại, quy trình cơ bản gồm các bước sau:

1. Đăng nhập WEEX trên nền tảng web.
2. Mở mục Quản lý API và tạo API Key mới.
3. Cấu hình các quyền cần thiết cho tích hợp của bạn.
4. Liên kết địa chỉ IP nếu phù hợp với thiết lập của bạn.
5. Lưu an toàn thông tin xác thực API được tạo hoặc cấu hình trong quá trình này.

Hiện tại, mỗi tài khoản WEEX có thể tạo tối đa 10 nhóm API Key. Nhờ đó, người dùng có thể duy trì các API Key riêng biệt cho từng ứng dụng hoặc thiết lập giao dịch, thay vì dùng một Key duy nhất cho mọi kết nối.

Khi tạo API Key, có ba thông tin xác thực quan trọng: APIKey dùng để nhận diện người dùng API trong quá trình xác thực. SecretKey là khóa riêng tư được sử dụng để tạo chữ ký cho yêu cầu.

Passphrase do người dùng đặt và là thông tin bắt buộc để truy cập có xác thực. WEEX cho biết nếu mất Passphrase thì không thể khôi phục và phải tạo API Key mới. Cần lưu trữ an toàn các thông tin xác thực này và không chia sẻ với người khác.

Cách cấu hình quyền API WEEX

API Key Spot WEEX mới tạo mặc định có quyền Read Only (chỉ đọc). Nhờ đó, Key có thể truy cập các chức năng truy vấn được hỗ trợ nhưng không được phép thực hiện giao dịch giao ngay.

Nếu ứng dụng cần đặt hoặc hủy lệnh giao ngay, bạn phải bật quyền Spot tương ứng.

Vì vậy, quyền phù hợp sẽ tùy thuộc vào chức năng ứng dụng cần thực hiện. Công cụ chỉ dùng để theo dõi số dư, xem lịch sử giao dịch hoặc phân tích thông tin có thể giữ quyền Read Only. Ứng dụng được thiết kế để thực hiện lệnh giao ngay cần có quyền giao dịch Spot.

WEEX cũng cho phép người dùng liên kết API Key với địa chỉ IP. Tài liệu chính thức cảnh báo rằng API Key không giới hạn và không liên kết IP tiềm ẩn thêm rủi ro bảo mật, đồng thời khuyến nghị liên kết địa chỉ IP khi tạo Key.

Thực tế, nên cấp cho mỗi tích hợp đúng những quyền mà nó cần, thay vì bật thêm các quyền truy cập mà ứng dụng sẽ không sử dụng.

Cách kết nối với REST API của WEEX

Sau khi chuẩn bị API Key và quyền truy cập, bạn có thể kết nối ứng dụng với REST API của WEEX. WEEX cung cấp endpoint REST API để lấy dữ liệu thị trường, thông tin tài khoản và thực hiện các thao tác giao dịch được hỗ trợ.

Có thể sử dụng endpoint công khai để lấy thông tin thị trường mà không cần xác thực. Các endpoint riêng tư, chẳng hạn như chức năng tài khoản và lệnh, yêu cầu xác thực bằng thông tin API của bạn và phải tuân thủ các yêu cầu về chữ ký trong tài liệu API WEEX chính thức.

Nên bắt đầu bằng cách thử gửi yêu cầu lấy dữ liệu thị trường công khai trước khi chuyển sang các chức năng cần xác thực. Khi kết nối hoạt động, bạn có thể dùng các endpoint riêng tư phù hợp với những quyền đã bật cho API Key của mình.

Endpoint API và các yêu cầu kỹ thuật có thể được cập nhật, vì vậy hãy luôn tham khảo tài liệu API WEEX mới nhất khi cấu hình tích hợp.

Cách kiểm tra kết nối API WEEX

Một cách đơn giản để bắt đầu tích hợp là xác nhận ứng dụng có thể giao tiếp thành công với API WEEX trước khi bổ sung các chức năng giao dịch phức tạp hơn.

Trước tiên, bạn có thể dùng các yêu cầu API công khai vì chúng không cần xác thực. Khi kết nối cơ bản hoạt động, hãy thử các yêu cầu đã xác thực theo những quyền được cấp cho API Key.

Nếu yêu cầu đã xác thực thất bại, bạn có thể cần kiểm tra một số phần trong thiết lập, bao gồm thông tin xác thực API, quyền truy cập, chữ ký yêu cầu, dấu thời gian, tên miền API và các hạn chế IP.

WEEX yêu cầu các yêu cầu đã xác thực phải sử dụng phương thức chữ ký chuẩn hóa. Theo tài liệu V3 hiện tại, dấu thời gian của yêu cầu được tính bằng mili giây và yêu cầu có thể bị từ chối nếu dấu thời gian chênh lệch với giờ máy chủ API WEEX quá 30 giây. 

Kiểm tra kết nối theo từng bước giúp xác định dễ dàng hơn vấn đề xuất phát từ kết nối, xác thực, quyền truy cập hay chính yêu cầu đó.

Bạn cần kiểm tra gì trước khi dùng API WEEX để giao dịch?

Trước khi dùng API WEEX để giao dịch, hãy xem lại quyền của API Key và đảm bảo Key chỉ có quyền truy cập cần thiết cho ứng dụng. WEEX cũng khuyến nghị liên kết API Key với các địa chỉ IP đáng tin cậy và bảo mật API Key, SecretKey cùng Passphrase.

Nhà phát triển cũng nên kiểm tra giới hạn tốc độ API hiện tại và xử lý lỗi yêu cầu đúng cách. Nếu vượt quá giới hạn áp dụng, yêu cầu có thể bị từ chối, vì vậy hệ thống tự động cần được thiết kế để hoạt động trong phạm vi giới hạn nêu trong tài liệu chính thức.

Trước khi dùng API để giao dịch thật, hãy kiểm tra kỹ kết nối, xác thực, quyền truy cập và logic đặt lệnh. Để biết các yêu cầu bảo mật và giới hạn tốc độ mới nhất, hãy tham khảo tài liệu API WEEX hiện hành.

Kết luận

Để bắt đầu sử dụng API WEEX, bạn cần chọn tài liệu chính thức phù hợp, tạo API Key, cấu hình quyền, bảo mật thông tin xác thực và kết nối ứng dụng với endpoint API tương ứng.

Nhà phát triển có thể bắt đầu bằng các yêu cầu API công khai trước khi chuyển sang các chức năng tài khoản hoặc giao dịch cần xác thực. Để cập nhật endpoint, yêu cầu xác thực, quyền truy cập và giới hạn tốc độ, hãy sử dụng tài liệu API WEEX mới nhất làm tài liệu tham khảo kỹ thuật chính.

FAQ

1. Tôi có thể tìm tài liệu API WEEX chính thức ở đâu?
WEEX cung cấp tài liệu riêng về các sản phẩm API, endpoint, xác thực, kết nối WebSocket, tham số và ví dụ phản hồi. Nhà phát triển nên sử dụng phiên bản mới nhất vì các tính năng API có thể được cập nhật theo thời gian.

2. Làm cách nào để tạo API Key WEEX?
Đăng nhập vào nền tảng web WEEX, rồi mở mục Quản lý API để tạo và cấu hình API Key. Hiện tại, mỗi tài khoản có thể tạo tối đa 10 nhóm API Key.

3. Tôi cần lưu thông tin nào sau khi tạo API Key WEEX?
Lưu an toàn APIKey, SecretKey và Passphrase. Không thể khôi phục Passphrase đã mất, vì vậy bạn phải tạo API Key mới nếu làm mất thông tin này.

4. API Key WEEX mới có những quyền nào?
API Key Spot mới mặc định có quyền Read Only (chỉ đọc). Để thực hiện giao dịch giao ngay, bạn phải bật quyền giao dịch Spot tương ứng.

5. Vì sao yêu cầu API WEEX của tôi không hoạt động?
Các nguyên nhân thường gặp gồm thông tin xác thực không chính xác, thiếu quyền, lỗi chữ ký, chênh lệch dấu thời gian, hạn chế IP hoặc giới hạn tốc độ. Hãy kiểm tra mục liên quan trong tài liệu API WEEX chính thức dựa trên lỗi mà yêu cầu trả về.