การยืนยันตัวตน
รับ API key
หัวข้อที่มีชื่อว่า “รับ API key”- เข้าสู่ระบบ dashboard ของ Gowajee ด้วยบัญชี Owner หรือ Admin role อื่นจะมองไม่เห็น key
- เปิด ระบบ → นักพัฒนา หน้านี้ชื่อ การตั้งค่านักพัฒนา
- ในส่วน API Key กดไอคอนรูปตาเพื่อแสดง key แล้วคัดลอก
- เก็บ key ไว้บน server เช่นเก็บเป็น environment variable ชื่อ
GOWAJEE_API_KEY
- Key ขึ้นต้นด้วย
gw_แล้วตามด้วยตัวอักษรอีก 32 ตัว - แต่ละองค์กรมี key เดียว และ key นี้ดูและสั่งงาน ทุก campaign ในองค์กร ได้
- ปุ่ม สร้าง API Key ใหม่ (Regenerate) ในหน้าเดียวกันจะออก key ใหม่มาแทน key เก่าใช้ไม่ได้ ทันที และ request
ที่ยังใช้ key เก่าจะได้
401สร้าง key ใหม่แล้วให้เอาไปอัปเดตในทุกระบบทันที
ส่ง key มากับทุก request
หัวข้อที่มีชื่อว่า “ส่ง key มากับทุก request”ใส่ key ไว้ใน header X-API-Key ของทุก request ที่เรียก /api/*
GET /api/agent/list HTTP/1.1Host: api.voice-agent.gowajee.aiX-API-Key: gw_3f9a1c2e7b4d4e0a9c8b1f2d3e4a5b6cชื่อ header ไม่แยกตัวพิมพ์เล็กพิมพ์ใหญ่ ส่งเป็น x-api-key ก็ได้
Base URL
หัวข้อที่มีชื่อว่า “Base URL”https://api.voice-agent.gowajee.aipath ทุกตัวในเอกสารนี้ขึ้นต้นด้วย /api/... และต่อท้าย URL นี้ รองรับเฉพาะ HTTPS
Error ของการยืนยันตัวตน
หัวข้อที่มีชื่อว่า “Error ของการยืนยันตัวตน”| กรณี | Status | code |
message |
|---|---|---|---|
ไม่ได้ส่ง header X-API-Key มา |
401 |
API_KEY_REQUIRED |
API key is required |
| Key ผิด หรือเป็น key เก่าที่สร้างใหม่ไปแล้ว | 401 |
INVALID_API_KEY |
Invalid API key |
| องค์กรยังไม่ได้รับสิทธิ์โทรออก (เจอเฉพาะตอนเริ่ม campaign) | 403 |
CALLING_NOT_ALLOWED |
Your organization is not allowed to make calls. |
Body ใช้โครงสร้าง error มาตรฐานเหมือน error อื่น ๆ
{ "success": false, "statusCode": 401, "code": "INVALID_API_KEY", "message": "Invalid API key", "errors": ["Invalid API key"]}