คู่มือการผสานรวม Housing Market API
ตารางอ้างอิง คำอธิบายเอนด์พอยต์ รหัสข้อผิดพลาด และตัวอย่าง สร้างขึ้นจากสเปกของ API และคงเป็นภาษาอังกฤษในทุกภาษา ชื่อ พารามิเตอร์ และรหัสจะเหมือนกันทุกที่
การยืนยันตัวตน
ส่งคีย์ของคุณในส่วนหัว x-api-key กับทุกคำขอ
เก็บคีย์ไว้บนเซิร์ฟเวอร์ของคุณ อย่าใส่คีย์ไว้ในแอปมือถือ หน้าเว็บ หรือรีโพสิทอรีสาธารณะโดยเด็ดขาด เพราะใครก็ตามที่มีคีย์จะสามารถใช้การสมัครใช้งานของคุณได้
คีย์หนึ่งเป็นของลูกค้าเพียงรายเดียว อย่าแชร์คีย์กับบริษัทอื่น ข้อกำหนดห้ามการกระทำดังกล่าว และเราสามารถเห็นได้ว่าคีย์ถูกใช้งานจากที่ใด
คีย์เดียวครอบคลุมสิทธิ์การเข้าถึงทั้งหมดของคุณ ได้แก่ ประเทศและแพ็กเกจของคุณ เมื่อคุณเพิ่มประเทศหรืออัปเกรด สิทธิ์ของคีย์จะเปลี่ยนไป โดยคุณไม่ได้รับคีย์ใหม่
คีย์ที่ไม่ได้ส่งมา ไม่รู้จัก หรือถูกเพิกถอนจะถูกปฏิเสธด้วย unauthenticated คีย์ที่ถูกต้องแต่ใช้จากที่อยู่ที่ไม่ได้ลงทะเบียนจะถูกปฏิเสธด้วย ip_not_allowed คีย์ที่หยุดชั่วคราวจะถูกปฏิเสธด้วย key_paused
ตัวอย่างคำขอ
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"