คู่มือการผสานรวม Housing Market API

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

การรับคีย์

คุณจะได้รับคีย์เมื่อสมัครใช้งานในคอนโซล ไม่ต้องรอคิวอนุมัติและไม่ต้องส่งอีเมลใด ๆ

  1. ลงชื่อเข้าใช้คอนโซล หรือสร้างบัญชี โดยเป็นบัญชีเดียวกับที่คุณใช้กับผลิตภัณฑ์อื่นของ Housing Market
  2. เลือกประเทศ ภูมิภาค หรือทั่วโลก เลือกแพ็กเกจ และเลือกการเรียกเก็บเงินรายเดือนหรือรายปี
  3. ป้อนที่อยู่ IP ที่เซิร์ฟเวอร์ของคุณจะใช้เรียก API
  4. ยอมรับข้อกำหนดการใช้งาน API เราจะเก็บบันทึกว่าคุณยอมรับอะไรและเมื่อใด
  5. ชำระเงิน คีย์ของคุณจะปรากฏหลังจากชำระเงินสำเร็จแล้วเท่านั้น และจะแสดงเพียงครั้งเดียว

โปรดคัดลอกคีย์ไปเก็บในที่เก็บข้อมูลลับของคุณทันที เราจัดเก็บเพียงค่าแฮชแบบทางเดียวของคีย์ จึงไม่สามารถแสดงคีย์ให้คุณได้อีก คีย์มีลักษณะดังนี้ hma_<prefix>_<secret>

คุณสามารถสร้างคีย์ทดแทนในคอนโซลได้ทุกเมื่อ คีย์เดิมจะยังใช้งานได้อีก 24 ชั่วโมงหลังจากนั้น เพื่อให้คุณสลับไปใช้คีย์ใหม่ได้โดยบริการไม่หยุดชะงัก

สถานะของคีย์

  • ใช้งานอยู่: คีย์ใช้งานได้
  • หยุดชั่วคราว: คีย์จะถูกปฏิเสธด้วย key_paused และจะกลับมาใช้งานได้เองเมื่อสาเหตุได้รับการแก้ไข
  • เพิกถอนแล้ว: คีย์จะถูกปฏิเสธอย่างถาวรด้วย unauthenticated

หากการชำระเงินค่าต่ออายุไม่สำเร็จ คีย์ของคุณจะยังใช้งานได้ในช่วงผ่อนผัน 5 วัน โดยเราจะส่งอีเมลแจ้งคุณในแต่ละขั้นตอน จากนั้นคีย์จะถูกหยุดชั่วคราว คีย์ที่หยุดชั่วคราวจะกลับมาใช้งานได้โดยอัตโนมัติทันทีที่ชำระเงินเรียบร้อย การโต้แย้งการชำระเงินจะทำให้คีย์ถูกหยุดชั่วคราวทันทีจนกว่าจะตรวจสอบเสร็จ

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