คีย์ API

คีย์ API ช่วยให้คุณเข้าถึง REST API ของ badges.ninja ได้ด้วยโปรแกรม ใช้เพื่อทำการสร้าง ออก และจัดการตราสัญลักษณ์ดิจิทัลโดยอัตโนมัติจากแอปพลิเคชันของคุณเอง

การสร้างคีย์ API

1. เปิดหน้า API Keys จากแถบด้านข้าง
2. คลิก Create API Key ฟอร์มแบบอินไลน์จะเปิดขึ้น:

3. ตั้งชื่อให้คีย์แล้วคลิก Create คีย์แบบเต็มจะแสดง เพียงครั้งเดียว บนแบนเนอร์สีเขียว:

4. คัดลอกคีย์ทันที — คีย์แบบเต็มจะแสดงเพียงครั้งเดียวเท่านั้น หากทำหาย คุณจะต้องสร้างคีย์ใหม่ หลังจากปิดแบนเนอร์แล้ว แดชบอร์ดจะแสดงเฉพาะคำนำหน้าของคีย์ (เช่น bws_a1b2c3d4...) ส่วนคีย์แบบเต็มจะถูกเก็บไว้ฝั่งเซิร์ฟเวอร์เพื่อใช้ยืนยันตัวตนคำขอของคุณ:

แต่ละแถวยังแสดงวันที่สร้างคีย์ และเมื่อคีย์ถูกใช้งานแล้วจะมีเวลา ใช้ล่าสุด เพื่อให้คุณสังเกตเห็นคีย์ที่ไม่ได้ใช้งานมานาน

ขอบเขตการเข้าถึง

เมื่อสร้างคีย์ คุณสามารถกำหนดให้เป็นแบบ อ่านอย่างเดียว หรือปล่อยให้เป็นแบบเข้าถึงได้เต็มรูปแบบ:

ขอบเขต	สิ่งที่อนุญาต
เข้าถึงเต็มรูปแบบ (ค่าเริ่มต้น)	อ่านและเขียน — แสดงรายการข้อมูล รวมถึงสร้าง ออก อัปเดต หรือลบ
อ่านอย่างเดียว	เฉพาะคำขอ GET ที่ปลอดภัยเท่านั้น คำขอใดๆ ที่เปลี่ยนแปลงข้อมูล (POST, PUT, PATCH, DELETE) จะถูกปฏิเสธด้วย 403 Forbidden

ใช้คีย์แบบอ่านอย่างเดียวสำหรับการเชื่อมต่อที่ต้องการเพียงอ่านข้อมูลของคุณ (รายงาน แดชบอร์ด การสำรองข้อมูล) เพื่อให้คีย์ที่รั่วไหลไม่สามารถเปลี่ยนแปลงอะไรได้ ติ๊กที่ Read-only key ในฟอร์มสร้างคีย์ คีย์แบบอ่านอย่างเดียวจะมีป้าย Read-only แสดงในรายการ คีย์ที่สร้างก่อนที่จะมีขอบเขตการเข้าถึงยังคงเข้าถึงได้เต็มรูปแบบ

รูปแบบของคีย์

คีย์ API ใช้คำนำหน้า bws_ ตามด้วยสตริงเลขฐานสิบหกยาว 32 ตัวอักษร:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

การใช้คีย์ API ในคำขอ

ใส่คีย์ API ไว้ในส่วนหัว X-Api-Key ของทุกคำขอ API:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

ดูรายละเอียดทั้งหมดของการยืนยันตัวตน API ได้ที่หน้า การยืนยันตัวตน

จำนวนคีย์ที่จำกัดตามแพ็กเกจ

จำนวนคีย์ API ที่คุณสร้างได้ขึ้นอยู่กับแพ็กเกจของคุณ:

แพ็กเกจ	จำนวนคีย์ API สูงสุด
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

การหมดอายุของคีย์

คีย์ API ทุกคีย์ จะหมดอายุหนึ่งปีหลังจากสร้าง เมื่อคีย์หมดอายุ คีย์จะไม่สามารถยืนยันตัวตนคำขอได้อีก เหมือนกับว่าถูกลบไปแล้ว ควรสร้างคีย์ใหม่ก่อนที่คีย์เดิมจะหมดอายุเพื่อไม่ให้เกิดการหยุดชะงัก

การลบคีย์

1. เปิดหน้า API Keys
2. ค้นหาคีย์ที่ต้องการลบ
3. คลิก Delete
4. ยืนยันการลบ

เมื่อลบแล้ว คีย์จะหยุดทำงานทันที แอปพลิเคชันใดๆ ที่ใช้คีย์นั้นจะได้รับข้อผิดพลาดด้านการยืนยันตัวตน