คีย์ API — tnea_ & tnsr_¶

NumerologyAPI ใช้คีย์ API สองตระกูล คีย์ทั้งสองมีลักษณะคล้ายกัน ถูกสร้างขึ้น ด้วยรูปแบบความปลอดภัยขนาด 80 ตัวอักษรเดียวกัน และตรวจสอบสิทธิ์ด้วย header X-API-Key เดียวกัน — แต่มีการคิดค่าใช้จ่ายที่แตกต่างกัน และมีไว้สำหรับ ผลิตภัณฑ์ที่แตกต่างกัน

1. รูปแบบคีย์และความปลอดภัย¶

ทุกคีย์มีความยาว80 ตัวอักษรพอดี:

tnea_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
tnsr_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

• คำนำหน้า 4 ตัวอักษรใช้ระบุประเภทของคีย์ ส่วนที่เหลืออีก 75 ตัวอักษร ถูกสร้างขึ้นจากแหล่งสุ่มที่ปลอดภัยเชิงการเข้ารหัส
• คีย์ถูกจัดเก็บในรูปแบบ SHA-256 hashed ฝั่งเซิร์ฟเวอร์ คีย์ในรูปแบบข้อความธรรมดาจะแสดง เพียงครั้งเดียว ในตอนที่สร้างเท่านั้น
• หากคีย์ถูกเปิดเผย ให้หมุนเวียนทันทีจากแดชบอร์ด

2. คีย์แพลตฟอร์ม (tnea_)¶

คีย์แพลตฟอร์มคือคีย์มาตรฐานสำหรับการผสานรวม NumerologyAPI เข้ากับ ผลิตภัณฑ์ของคุณเอง — เว็บไซต์ แอปมือถือ และบริการฝั่งเซิร์ฟเวอร์

การตรวจสอบสิทธิ์¶

ส่งคีย์ในทุกคำขอด้วย header X-API-Key:

curl --request GET \
  --url "https://api.numerologyapi.com/api/v1/life_path?birth_year=1990&birth_month=5&birth_day=15" \
  --header "x-api-key: tnea_YOUR_API_KEY"

การคิดค่าใช้จ่าย¶

การเรียก /api/v1 ที่คิดเงินจะถูกหักจากวอลเล็ตเครดิตขององค์กร (จ่ายตามการใช้งาน) คุณสามารถเติมเงินเข้าวอลเล็ตได้ทุกเมื่อจาก แดชบอร์ด

กฎของช่องทาง: คีย์แพลตฟอร์มต้องไม่ส่ง header X-Numora-Client การส่งจะคืนค่า 403 — header นั้นสงวนไว้สำหรับช่องทางเดสก์ท็อป

3. คีย์ Numora Studio (tnsr_)¶

คีย์ Numora Studio ใช้ตรวจสอบสิทธิ์แอปเดสก์ท็อป Numora Studio (macOS/Windows) ที่นักปฏิบัติใช้สร้างรายงานให้ลูกค้า คีย์เหล่านี้เป็น คีย์คู่ขนานกับคีย์แพลตฟอร์มที่มีรูปแบบเหมือนกันทุกประการ แต่ถูกเรียกเก็บเงินจาก โควต้าแพ็กเกจ Numora Studio ขององค์กรแทนเครดิตแพลตฟอร์ม

การจัดเตรียม¶

คีย์ tnsr_ ถูกสร้างขึ้นด้วยวิธีใดวิธีหนึ่งดังนี้:

• ผ่านขั้นตอนการลงชื่อเข้าของแอปเดสก์ท็อป (หน้าขอยินยอมของเบราว์เซอร์จะจัดเตรียม คีย์ให้โดยอัตโนมัติ) หรือ
• สร้างด้วยตนเองบนหน้า คีย์ API ของแดชบอร์ด (/api-keys)

ลายเซ็นช่องทาง (บังคับ)¶

ทุกการเรียกที่ใช้คีย์ tnsr_ ต้องมี header ช่องทางเดสก์ท็อป:

การบังคับใช้ฝั่งเซิร์ฟเวอร์:

• คีย์ tnsr_ โดยไม่มี X-Numora-Client → 403
• คีย์ tnea_ ที่มี X-Numora-Client → 403

การคิดค่าใช้จ่าย¶

• การเรียก /api/v1 ที่คิดเงินจะถูกหักจากโควต้าแพ็กเกจ Numora Studio ขององค์กร (กลุ่มทรัพยากรร่วมกันเดียวสำหรับคีย์ tnsr_ ทั้งหมดขององค์กร)
• มีสวิตช์เครดิตสำรองต่อคีย์ tnsr_: เมื่อโควต้าแพ็กเกจ หมด คีย์อาจสำรองไปใช้เครดิตแพลตฟอร์มขององค์กร (ปิดโดยค่าเริ่มต้น)
• หากโควต้าหมดและไม่เปิดเครดิตสำรอง การเรียกจะคืนค่า 429

การล็อกอุปกรณ์ (ไม่บังคับ)¶

คีย์ tnsr_ สามารถล็อกกับอุปกรณ์ที่ลงทะเบียนได้ เมื่อเปิดการล็อกแล้ว ทุก คำขอต้องมี X-Numora-Device-Id ที่ลงทะเบียนกับองค์กร อุปกรณ์ที่ไม่ลงทะเบียนจะถูกปฏิเสธด้วย 403

Endpoints เฉพาะเดสก์ท็อป¶

บาง endpoints สงวนไว้สำหรับช่องทางเดสก์ท็อปและคืนค่า 403 สำหรับ คีย์ tnea_:

• POST /api/v1/numora/report-bundle — รายงานลูกค้าฉบับสมบูรณ์ในการเรียกครั้งเดียว
• POST /api/v1/numora/order — ขั้นตอนการซื้อแพ็กเกจ/โควต้าในแอป
• POST /api/v1/numora/devices/register — ลงทะเบียนการติดตั้งเดสก์ท็อป
• GET /api/v1/numora/studio-status — ยอดคงเหลือและมิเตอร์โควต้าของเดสก์ท็อป

เคล็ดลับ: การตอบสนองที่คิดเงินยังพ่วง header X-Remaining-Credits และ X-Remaining-Tokens เพื่อให้คุณติดตามยอดคงเหลือแบบเรียลไทม์ได้โดยไม่ต้อง เรียกเพิ่ม

4. การจัดการคีย์ (แดชบอร์ด)¶

หน้า คีย์ API ของแดชบอร์ด (/api-keys) คือศูนย์ควบคุมสำหรับคีย์ ทั้งสองประเภท

บทบาท: บทบาท admin และ developer สามารถสร้างและจัดการคีย์ได้ finance ไม่สามารถสร้างคีย์ API สำหรับการผลิตได้ การดำเนินการทางการเงิน (การซื้อแพ็กเกจ การเติมเงิน) จำกัดเฉพาะ admin และ finance

หลายคีย์: องค์กรสามารถถือคีย์ได้หลายคีย์ทั้งสองประเภท — ตัวอย่างเช่น คีย์ tnsr_ หนึ่งคีย์ต่อนักปฏิบัติหรือต่อการติดตั้งเดสก์ท็อป โควต้า ถูกแชร์ต่อองค์กร ดังนั้นคีย์จึงไม่ "แย่ง" ยอดคงเหลือของตัวเอง

5. แนวทางปฏิบัติที่ดีที่สุด¶

• ปฏิบัติต่อคีย์เหมือนรหัสผ่าน อย่าฝังคีย์ในโค้ดฝั่งไคลเอ็นต์ ที่เก็บโค้ดสาธารณะ หรือบันทึก (log)
• ใช้ตัวแปรสภาพแวดล้อมหรือตัวจัดการความลับ (secrets manager) ในแบ็กเอนด์ของคุณ
• หมุนเวียนทันที หากคีย์ถูกบุกรุกหรือสมาชิกในทีมออกไป
• ใช้คีย์ tnsr_ หนึ่งคีย์ต่อการติดตั้งเดสก์ท็อป เพื่อให้การจัดการอุปกรณ์ และการเพิกถอนง่ายขึ้น
• เปิดการล็อกอุปกรณ์ สำหรับองค์กรที่ต้องการความปลอดภัยสูง
• ติดตามการใช้งาน ในแดชบอร์ดเพื่อจับการพุ่งสูงผิดปกติได้ตั้งแต่เนิ่นๆ

6. คำถามที่พบบ่อย¶

คีย์ tnsr_ เรียก endpoints แพลตฟอร์มปกติได้หรือไม่? ได้ คีย์ Numora Studio ตรวจสอบสิทธิ์ทั้งพื้นที่ /api/v1 การเรียกเหล่านั้น ถูกคิดเงินจากโควต้าแพ็กเกจ Numora Studio

คีย์ tnea_ เรียก endpoints /numora/* เฉพาะเดสก์ท็อปได้หรือไม่? ไม่ได้ Endpoints เฉพาะเดสก์ท็อปคืนค่า 403 สำหรับคีย์แพลตฟอร์ม

ทำไมฉันถึงได้รับ 403 เมื่อเรียกด้วยคีย์ tnsr_? ส่วนใหญ่แล้ว header X-Numora-Client หายไป หรือ app id ไม่ตรงกัน ตรวจสอบว่าทุกคำขอรวม X-Numora-Client: numora-studio/<version>

ทำไมฉันถึงได้รับ 403 กับคีย์ tnea_? คีย์แพลตฟอร์มต้องไม่พก header X-Numora-Client — ลบออก

จะเกิดอะไรขึ้นเมื่อโควต้าหมด? การเรียกที่คิดเงินจะคืนค่า 429 เว้นแต่เปิดเครดิตสำรองบนคีย์ tnsr_ ของคุณ (หรือเติมเงินวอลเล็ตแพลตฟอร์มสำหรับคีย์ tnea_)

เกี่ยวข้อง¶

• เริ่มต้นการใช้งาน
• ราคา
• โซลูชันสำหรับองค์กร