Xác thực
Xác thực
Mọi request đến FourA API đều yêu cầu xác thực. Trang này giải thích cách lấy, sử dụng và quản lý API key của bạn.
Lấy API Key của bạn
- Đăng nhập vào FourA Dashboard
- Đi đến trang API Keys
- Nhấp vào Create Key
- Sao chép key từ hộp thoại xác nhận
API key của bạn trông như thế này: pk_live_a1b2c3d4e5f6...
Các key được tạo hôm nay có thể hiển thị lại: nhấp vào biểu tượng con mắt trên hàng của key sau đó để mang toàn bộ mã bí mật trở lại khi có yêu cầu (xem Quản lý API Keys để biết luồng hiển thị và quyền). Các key cũ được tạo trước khi tính năng hiển thị được phát hành không thể lấy lại và hiển thị biểu tượng ổ khóa; hãy tạo lại chúng một lần để chuyển đổi.
Sử dụng API Key của bạn
Bao gồm API key của bạn trong 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 coi API key của bạn giống như một mật khẩu:
- Không commit nó vào quản lý phiên bản. Sử dụng các biến môi trường để thay thế.
- Không để lộ nó trong mã client-side. Chỉ sử dụng nó trong các ứng dụng server-side.
- Xoay vòng nếu bị lộ. Tạo lại key từ Dashboard. Mã bí mật cũ sẽ ngừng hoạt động ngay lập tức, và mọi lần hiển thị đều được ghi log kiểm toán nên rất dễ phát hiện thông tin xác thực bị đánh cắp sau khi sự việc xảy ra.
Sử dụng các biến môi trường
Lưu trữ key của bạn trong một biến môi trường:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Sau đó tham chiếu nó trong mã 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 phổ biến
Tất cả các lỗi xác thực đều trả về trạng thái 401 Unauthorized.
| Lỗi | Thông báo | Nguyên nhân | Khắc phục |
|---|---|---|---|
| 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 | Sai key, thừa khoảng trắng, hoặc key đã bị vô hiệu hóa | Xác minh lại key, xóa khoảng trắng, hoặc tạo một key mới từ Dashboard |
Mọi response, dù thành công hay thất bại, đều mang một header X-Foura-Request-Id. Hãy ghi log nó ở phía bạn để bộ phận hỗ trợ có thể tra cứu một lệnh gọi cụ thể sau này.
Các bước tiếp theo
- Bắt đầu nhanh: Thực hiện request đầu tiên của bạn
- Quản lý API Keys: Hiển thị, chỉnh sửa, tạo lại và xóa key
- API Endpoints: Tham chiếu endpoint đầy đủ
- Xử lý lỗi: Xử lý các lỗi xác thực một cách khéo léo