រំលងទៅមាតិកាមេ

ឯកសារ

អ្វីៗទាំងអស់ដែលលោកអ្នកត្រូវការសម្រាប់សមាហរណកម្ម

មគ្គុទ្ទេសក៍ ឯកសារយោង និងលក្ខណៈបច្ចេកទេស ត្រូវបានបង្កើតចេញពីឯកសារ OpenAPI តែមួយ ដូច្នេះវាតែងតែស្របគ្នា។ ឈ្មោះសម្គាល់ដូចគ្នានៅគ្រប់ភាសា។

  • មគ្គុទ្ទេសក៍សមាហរណកម្ម

    ការទទួលសោ ការផ្ទៀងផ្ទាត់អត្តសញ្ញាណ តម្រង ការបែងចែកទំព័រ ដែនកំណត់ និងកំហុស ជាភាសារបស់លោកអ្នក។

    បើកមគ្គុទ្ទេសក៍

  • លក្ខណៈបច្ចេកទេស OpenAPI

    ឯកសារ OpenAPI 3.1 ដែលឯកសារយោងត្រូវបានបង្កើតចេញពីវា សម្រាប់កម្មវិធីបង្កើតកូដ និងឧបករណ៍ API។

    ទាញយកលក្ខណៈបច្ចេកទេស

  • មគ្គុទ្ទេសក៍ PDF

    មគ្គុទ្ទេសក៍សមាហរណកម្មជាឯកសារតែមួយ សម្រាប់អានក្រៅបណ្តាញ ឬចែករំលែកជាមួយក្រុមការងាររបស់លោកអ្នក។

    ទាញយក PDF

ឯកសារនេះជាសាធារណៈ។ លោកអ្នកត្រូវការសោតែនៅពេលហៅ API ប៉ុណ្ណោះ។

ចាប់ផ្តើមរហ័ស

ពិនិត្យសោរបស់លោកអ្នក និងអាសយដ្ឋានដែលយើងខ្ញុំឃើញ
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
អានទំព័រដំបូងនៃការផ្សាយសម្រាប់ប្រទេសមួយ
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

សង្ខេប

URL គោល
https://api.housingmarketapi.com
ការផ្ទៀងផ្ទាត់អត្តសញ្ញាណ
សោនៅក្នុងក្បាល x-api-key ដែលផ្ញើពីអាសយដ្ឋានម៉ាស៊ីនមេដែលបានចុះឈ្មោះសម្រាប់វា។

ចំណុចបញ្ចប់

ចំណុចបញ្ចប់កម្រិតការពិពណ៌នា
GET /v1/pingស្តង់ដារបញ្ជាក់ថាសោរបស់លោកអ្នកដំណើរការពីអាសយដ្ឋានដែលវាបានចុះឈ្មោះ ហើយបង្ហាញអាសយដ្ឋាននោះមកវិញ។
GET /v1/propertiesស្តង់ដារការផ្សាយដែលបានបោះផ្សាយ សម្រាប់ប្រទេសមួយដែលសោរបស់លោកអ្នកគ្របដណ្តប់ ម្តងមួយទំព័រ។
GET /v1/insights/*កម្រិតខ្ពស់ទិន្នន័យទីផ្សារសរុបតាមទីតាំង និងរយៈពេល សម្រាប់សោ «កម្រិតខ្ពស់»។ នឹងមកដល់ឆាប់ៗ៖ ចំណុចបញ្ចប់ទាំងនេះមិនទាន់ដំណើរការនៅឡើយទេ។

កូដកំហុស

កំហុសនីមួយៗមានស្ថានភាព HTTP និងកូដមួយក្នុងចំណោមកូដទាំងនេះ។ សូមបែងចែកដំណើរការតាមកូដ មិនមែនតាមសារទេ។

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
ទទួលសោ API របស់លោកអ្នកមើលតម្លៃ