การยืนยันตัวตน

การเข้าถึง Partner API ต้องยืนยันตัวตนด้วยคีย์ลับของ API สร้างและจัดการคีย์ของคุณได้ผ่าน Partner Console

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

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

ยืนยันตัวตนของคำขอโดยใช้ HTTP Basic Auth โดยส่งคีย์ API ของคุณเป็นชื่อผู้ใช้ และเว้นรหัสผ่านว่างไว้

API รองรับเฉพาะการเชื่อมต่อ HTTPS ที่ปลอดภัยเท่านั้น คำขอผ่าน HTTP ธรรมดาจะถูกปฏิเสธ เช่นเดียวกับคำขอใด ๆ ที่ไม่มีข้อมูลประจำตัวสำหรับการยืนยันตัวตนที่ถูกต้อง

ตัวอย่างคำขอ

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

ตรวจสอบคีย์ลับ

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }