API Reference
Authentication
ทุก request ฝั่ง production ต้องแนบ API key ใน header X-API-Key สร้าง หมุน และเพิกถอนได้ที่ Dashboard
http
X-API-Key: your-api-key
สร้างคีย์
- เข้า dashboard.aksonocr.com
- ไปที่ API Keys แล้วสร้างคีย์ใหม่
- คัดลอกค่าตอนสร้างครั้งเดียว แล้วเก็บเป็น secret ฝั่งเซิร์ฟเวอร์
ส่งคีย์อย่างไร
| วิธี | ใช้เมื่อ |
|---|---|
X-API-Key | ทุก API production — วิธีที่รองรับ |
| Query / cookie | ไม่ใช้กับ backend API (ใช้เฉพาะพอร์ทัลเว็บของ instance) |
bash
curl -sS https://backend.aksonocr.com/api/v3/key-extract/capabilities \-H 'X-API-Key: <YOUR_API_KEY>'
เมื่อ auth ไม่ผ่าน
ได้ 401 อย่า retry ด้วยคีย์เดิมโดยไม่ตรวจ
json
{"type": "https://docs.aksonocr.com/problems/invalid-api-key","title": "Unauthorized","status": 401,"code": "invalid_api_key","detail": "The API key is missing or invalid.","retryable": false,"request_id": "req_01J..."}
แนวทาง
- เก็บคีย์เป็น secret ฝั่งเซิร์ฟเวอร์ ห้ามฝังในแอปมือถือหรือ frontend สาธารณะ
- สร้างคีย์แยกต่อสภาพแวดล้อม (dev / staging / prod)
- ถ้าคีย์รั่ว ให้เพิกถอนทันทีแล้วสร้างใหม่
- เดโมบนเว็บไซต์ใช้ลิมิตต่อ IP ไม่ใช่คีย์ของคุณ
ลิมิตต่อคีย์อยู่ที่ Rate Limits