Xác thực
Mọi request đế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 của bạn
- Đăng nhập vào FourA Dashboard
- Đi tới trang API Keys
- Nhấp vào Create Key
- Sao chép key ngay lập tức (nó sẽ không hiển thị lại đầy đủ)
API key của bạn có dạng như sau: pk_live_a1b2c3d4e5f6...
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 bảo mật 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 (version control). Hãy sử dụng biến môi trường (environment variables) thay thế.
- Không để lộ key trong mã nguồn phía client (client-side code). Chỉ sử dụng key trong các ứng dụng phía server (server-side).
- Thu hồi và đổi mới (rotate) nếu bị lộ. Tạo một key mới từ Dashboard và vô hiệu hóa key cũ.
Sử dụng 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ã nguồn 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.
| Lỗi | Thông điệp | Nguyên nhân | Cách 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 thừa hoặc tạo key mới từ Dashboard |
Các bước tiếp theo
- Quick Start: Thực hiện request đầu tiên của bạn
- API Endpoints: Tài liệu tham khảo đầy đủ về endpoint
- Error Handling: Xử lý lỗi xác thực một cách mượt mà