คีย์ API

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

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

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

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

4. คัดลอกคีย์ทันที — แสดงเพียงครั้งเดียวเท่านั้น หากคุณทำหาย คุณจะต้องสร้างใหม่ หลังจากปิดแบนเนอร์ จะเก็บไว้เพียงคำนำหน้าเท่านั้น:

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

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

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

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

รูปแบบคีย์

คีย์ API ใช้คำนำหน้า bws_ ตามด้วยสตริงเลขฐาน 16 ความยาว 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

การลบคีย์

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

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