Authentication
วิธีการยืนยันตัวตนเพื่อเข้าใช้งาน API ของเรา
เพื่อความปลอดภัยและการจัดการทรัพยากรที่มีประสิทธิภาพ การเรียกใช้งาน API ทั้งหมดบนแพลตฟอร์มนี้จำเป็นต้องมีการยืนยันตัวตน (Authentication) โดยใช้ API Key ซึ่งคุณสามารถจัดการคีย์ของคุณได้ตามรายละเอียดด้านล่าง
วิธีการสร้าง API Key
คุณสามารถสร้างและจัดการ API Key ของคุณเองได้ง่ายๆ ตามขั้นตอนดังนี้:
เข้าสู่ระบบ เข้าสู่บัญชีผู้ใช้งานของคุณบนเว็บไซต์
ไปที่หน้า "API Keys" ผ่านทางเมนูผู้ใช้งาน (คลิกที่รูปโปรไฟล์มุมขวาบน)
คลิกปุ่ม "สร้าง API Key" แล้วระบุชื่อคีย์เพื่อช่วยในการจดจำ (เช่น "Production Server" หรือ "Test App")
สำคัญ: ระบบจะแสดง API Key ตัวเต็มให้คุณเห็นเพียงครั้งเดียวเท่านั้น โปรดคัดลอกและเก็บรักษาไว้ในที่ปลอดภัยทันที
หลังจากที่คุณได้ API Key แล้ว คุณสามารถเลือกใช้งานได้ 2 รูปแบบ:
1. ผ่านทาง HTTP Header (แนะนำ)
วิธีนี้เป็นวิธีที่ปลอดภัยที่สุดและเป็นมาตรฐานสากล โดยการแนบ API Key ไปใน Header ของ HTTP Request ภายใต้ชื่อ x-api-key
curl -X GET \"https://horo.phatsanphon.com/api/lunar-date?date=1996-09-09" \ -H "x-api-key: YOUR_API_KEY"fetch('https://horo.phatsanphon.com/api/lunar-date?date=1996-09-09', {method: 'GET',headers: {'x-api-key': 'YOUR_API_KEY'}}) .then(response => response.json()) .then(data => console.log(data));2. ผ่านทาง Query Parameter
สำหรับกรณีที่ไม่สะดวกในการปรับแต่ง HTTP Header (เช่น การเรียกใช้ผ่าน Image Tag หรือลิงก์โดยตรง) คุณสามารถแนบ API Key ไปที่ URL ของ Request ผ่าน Parameter ชื่อ appid
curl -X GET \"https://horo.phatsanphon.com/api/lunar-date?date=1996-09-09&appid=YOUR_API_KEY"Error Responses (ข้อผิดพลาด)
หากการยืนยันตัวตนล้มเหลว API จะตอบกลับด้วย HTTP Status Code 401 Unauthorized พร้อมกับข้อความอธิบายดังต่อไปนี้:
| Error Message | Description |
|---|---|
| Missing API Key | คุณไม่ได้แนบ API Key เข้ามาใน Request |
| Invalid API Key | API Key ที่ส่งมาไม่ถูกต้อง หรือถูกยกเลิกไปแล้ว |