ภาพรวม/OpenAPI/การรับรอง

การรับรอง

การตั้งค่าและตรวจสอบคีย์ API ของคุณได้อย่างปลอดภัย

พันธมิตร API คีย์

KPainter OpenAPI endpoint ทั้งหมดยกเว้น GET /Health ใช้คีย์ API ของผู้ใช้:

Authorization: Bearer <your_api_key>

เปิดใช้งานและคัดลอกคีย์จาก หน้าหลัก API.

ตรวจสอบการเชื่อมต่อครั้งแรก

curl -s "https://api.kpainter.ai/openapi/v1/me" \  -H "Authorization: Bearer $KPAINTER_API_KEY"

การตอบสนองที่ประสบความสําเร็จจะคืนบัญชีที่ปลอดภัยและคํานวณแผน ตรวจสอบสิ่งนี้ก่อนสร้างเนื้อหา

คีย์จัดเก็บปลอดภัย

  • เก็บแต่ละคีย์ในร้านค้าที่ซ่อนอยู่ด้านเซิร์ฟเวอร์หรือการเชื่อมต่อตัวแทนที่เชื่อถือได้
  • อย่าใส่กุญแจในรหัสเบราว์เซอร์แพคเกจมือถือภาพหน้าจอหรือบันทึก
  • อย่าใช้คีย์ที่ใช้ร่วมกันสําหรับผู้ใช้ปลายที่ไม่เกี่ยวข้อง
  • ไม่เคย echo คีย์เต็มในข้อความข้อผิดพลาด
  • ขอให้ผู้ใช้จะเชื่อมต่ออีกครั้งหลังจากตั้งค่าใหม่คีย์

คําตอบทั่วไป

  • 401: คีย์จะหายไป invalid หรือ inactive
  • 403:บัญชีไม่สามารถใช้ความสามารถที่ต้องการ
  • 422: การรวมฟิลด์หรือพารามิเตอร์นั้นไม่ถูกต้อง
  • 429: คําถามเป็นเรื่องบ่อยเกินไปตามคําแนะนําการตอบสนองก่อนที่จะ退休
  • การสมดุลที่ไม่เพียงพอ: การสร้างรายงานสถานะหยุดชั่วคราวการรับเงินที่ประเมินและกิจกรรมที่มีอยู่ อย่าสร้างคู่

การเปิดใช้งาน, การตั้งค่าใหม่และการลบคีย์ API จะยังคงอยู่บนเว็บไซต์ KPainter; OpenAPI ไม่จัดการคีย์