API Reference

Authentication

ทุก request ฝั่ง production ต้องแนบ API key ใน header X-API-Key สร้าง หมุน และเพิกถอนได้ที่ Dashboard

http
X-API-Key: your-api-key

สร้างคีย์

  1. เข้า dashboard.aksonocr.com
  2. ไปที่ API Keys แล้วสร้างคีย์ใหม่
  3. คัดลอกค่าตอนสร้างครั้งเดียว แล้วเก็บเป็น secret ฝั่งเซิร์ฟเวอร์

ส่งคีย์อย่างไร

วิธีใช้เมื่อ
X-API-Key: <key>วิธีหลัก — ใช้ในทุกตัวอย่างของเอกสารนี้
Authorization: Bearer <key>รับเช่นกัน สำหรับ client ที่ตั้ง header นี้ได้ง่ายกว่า
Query stringไม่รองรับ — อย่าใส่คีย์ใน URL เพราะจะติดไปกับ log
bash
curl -sS https://backend.aksonocr.com/api/v3/key-extract/capabilities \
-H 'X-API-Key: <YOUR_API_KEY>'

เมื่อ auth ไม่ผ่าน

ได้ 401 อย่า retry ด้วยคีย์เดิมโดยไม่ตรวจ รูปแบบ body ต่างกันตาม API: Key Extraction v3 ตอบเป็น problem+json

json
{
"type": "https://docs.aksonocr.com/problems/invalid-api-key",
"title": "Invalid Api Key",
"status": 401,
"code": "invalid_api_key",
"detail": "Invalid API key",
"instance": "urn:aksonocr:request:req_mwkifcnl",
"retryable": false,
"request_id": "req_mwkifcnl"
}

OCR v2 / v3 ตอบรูปแบบเดิม ให้ดูจาก HTTP status เป็นหลัก

json
{
"success": false,
"error": { "code": "HTTP_ERROR", "message": "An error occurred while processing your request" },
"timestamp": "2026-11-17T09:48:38.961Z",
"path": "/api/v2/ocr",
"method": "POST"
}

แนวทาง

  • เก็บคีย์เป็น secret ฝั่งเซิร์ฟเวอร์ ห้ามฝังในแอปมือถือหรือ frontend สาธารณะ
  • สร้างคีย์แยกต่อสภาพแวดล้อม (dev / staging / prod)
  • ถ้าคีย์รั่ว ให้เพิกถอนทันทีแล้วสร้างใหม่
  • เดโมบนเว็บไซต์ใช้ลิมิตต่อ IP ไม่ใช่คีย์ของคุณ
ลิมิตต่อคีย์อยู่ที่ Rate Limits