Xác thực
Xác thực
Mọi request gửi đến FourA API đều yêu cầu xác thực. Trang này hướng dẫn cách lấy, sử dụng và quản lý API key của bạn.
Lấy API key
- Đăng nhập vào FourA Dashboard
- Đi tới trang API Keys
- Nhấp vào Create Key
- Sao chép khóa từ hộp thoại xác nhận
API key của bạn có định dạng như sau: pk_live_a1b2c3d4e5f6...
Các khóa tạo hiện nay đều có thể hiển thị lại: nhấp vào biểu tượng con mắt trên hàng của khóa sau này để xem lại toàn bộ chuỗi bí mật khi cần (xem Quản lý API Key để biết quy trình hiển thị và phân quyền). Các khóa cũ tạo trước khi tính năng này ra mắt không thể xem lại và sẽ hiển thị biểu tượng ổ khóa; hãy tạo lại một lần để chuyển đổi.
Sử dụng API key
Đưa API key của bạn vào header X-API-Key của mọi request:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
Trong Python:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
Trong Node.js:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
Bảo mật API Key
Hãy xử lý API key của bạn như mật khẩu:
- Không commit key vào hệ thống quản lý phiên bản. Hãy sử dụng biến môi trường.
- Không để lộ key trong mã nguồn client-side. Chỉ sử dụng key trong các ứng dụng server-side.
- Xoay vòng key nếu bị lộ. Tạo lại key từ Dashboard. Secret cũ sẽ ngừng hoạt động trong vòng một phút, và mỗi lần xem key đều được ghi log kiểm toán để dễ dàng phát hiện thông tin xác thực bị đánh cắp sau đó.
Sử dụng biến môi trường
Lưu trữ key của bạn trong biến môi trường:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Sau đó tham chiếu nó trong code của bạn:
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
Các Lỗi Xác Thực Thường Gặp
Tất cả các lỗi xác thực đều trả về trạng thái 401 Unauthorized.
| Error | Message | Cause | Fix |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | Không có header X-API-Key trong request |
Thêm header X-API-Key |
| 401 | Invalid API key | Key không đúng, thừa khoảng trắng hoặc key đã bị hủy kích hoạt | Xác minh key, xóa khoảng trắng thừa hoặc tạo key mới từ Dashboard |
Mọi response, dù thành công hay thất bại, đều chứa header X-Foura-Request-Id, ngoại trừ phần body mà FourA hoàn toàn không đọc được (JSON sai định dạng, hoặc body vượt quá 100 KB), vốn bị từ chối trước khi một ID được gán. Hãy ghi log giá trị này ở phía bạn để bộ phận hỗ trợ có thể tra cứu lệnh gọi cụ thể sau này.
Các Bước Tiếp Theo
- Quick Start: Thực hiện request đầu tiên của bạn
- Quản lý API Key: Hiển thị, chỉnh sửa, tạo lại và xóa key
- API Endpoints: Tài liệu tham khảo endpoint đầy đủ
- Xử Lý Lỗi: Xử lý lỗi xác thực một cách tối ưu