Xác thực yêu cầu API

Gửi khóa API trong header

API lập trình công khai được cung cấp tại https://api.threetone.in. Gửi khóa API trong header yêu cầu x-api-key:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Dùng khóa làm giá trị header. Không đặt khóa trong URL, chuỗi truy vấn hoặc phần thân yêu cầu. Yêu cầu lập trình cần gửi x-api-key; nếu gửi kèm header Authorization, yêu cầu sẽ bị từ chối vì thông tin xác thực không rõ ràng.

Giữ khóa ở phía máy chủ

Tải khóa từ trình quản lý bí mật phía máy chủ hoặc biến môi trường. Không nhúng khóa vào JavaScript giao diện, gói ứng dụng di động, nhật ký hoặc thông báo lỗi. Dùng khóa riêng với phạm vi hẹp cho từng tích hợp đã triển khai để một thông tin xác thực bị lộ không làm lộ các thao tác không liên quan.

Ghi lại mã yêu cầu

Threetone trả về header phản hồi X-Request-Id. Khi khắc phục sự cố, hãy lưu giá trị này cùng dấu thời gian, phương thức, đường dẫn và trạng thái của yêu cầu. Bạn cũng có thể gửi X-Request-Id hợp lệ của riêng mình; API sẽ trả lại giá trị đó trong phản hồi.