全國省市區(qū)街道區(qū)域信息 API 接口
提供全國省市區(qū)街道區(qū)域信息。
1. 產(chǎn)品功能
提供全國最新、最全的省市區(qū)鎮(zhèn)街道區(qū)域信息;
第一時間更新區(qū)域信息變動锁右;
最小級別可以詳細到鎮(zhèn)、街道級別讶泰,為國內(nèi)區(qū)域單元最小級別咏瑟;
全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
全面兼容 Apple ATS痪署;
全國多節(jié)點 CDN 部署码泞;
接口極速響應,多臺服務器構建 API 接口負載均衡狼犯。
2. API 文檔
API 詳情地址: https://www.gugudata.com/api/details/chinaregions
接口請求地址: https://api.gugudata.com/location/chinaregions
返回格式: application/json; charset=utf-8
請求方式: GET
請求協(xié)議: HTTPS
請求示例: https://api.gugudata.com/location/chinaregions?appkey=YOUR_APPKEY®ioncode=YOUR_VALUE
接口測試: https://api.gugudata.com/location/chinaregions/demo
3. 請求參數(shù)(如果為 POST 請求余寥,那么參數(shù)以 JSON 的格式傳遞)
參數(shù)名參數(shù)類型是否必須默認值備注
appkeystring是YOUR_APPKEY付費后獲取的 APPKEY
regioncodestring是YOUR_VALUE需要查詢的父級區(qū)域編碼,0 獲取全國所有拭跎宋舷;編碼格式為 00000000,每兩位分別對應省呐馆、市肥缔、區(qū)莲兢、鎮(zhèn)/街道編碼
4. 返回參數(shù)
參數(shù)名參數(shù)類型備注
DataStatus.StatusCodeint接口返回狀態(tài)碼
DataStatus.StatusDescriptionstring接口返回狀態(tài)說明
DataStatus.ResponseDateTimestring接口數(shù)據(jù)返回時間
DataStatus.DataTotalCountint此條件下的總數(shù)據(jù)量汹来,一般用于分頁計算
Data.RegionCodestring區(qū)域編碼
Data.RegionNamestring區(qū)域名稱
Data.RegionTypestring區(qū)域級別
5. 接口響應狀態(tài)碼
狀態(tài)碼狀態(tài)碼解釋備注
100正常返回可通過判斷此狀態(tài)碼斷言接口正常返回
-1請求失敗請求處理請求失敗
501參數(shù)錯誤請檢查您傳遞的參數(shù)個數(shù)以及參數(shù)類型是否匹配
502請求頻率受限一般建議每秒請求不超過 100 次
503APPKEY 權限超限/訂單到期請至開發(fā)者中心檢查您的 APPKEY 是否到期或是否權限超限
504APPKEY 錯誤請檢查傳遞的 APPKEY 是否為開發(fā)者中心獲取到的值
505請求的次數(shù)超出接口限制請檢查對應接口是否有請求次數(shù)限制以及您目前的接口請求剩余次數(shù)
900接口內(nèi)部響應錯誤接口可用性為 99.999%,如獲取到此狀態(tài)碼請郵件聯(lián)系我們
6. 開發(fā)語言請求示例代碼
示例代碼包含的開發(fā)語言:C#, Go, Java, jQuery, Node.js, Objective-C, PHP, Python, Ruby, Swift 等改艇,其他語言進行對應的 RESTful API 請求實現(xiàn)即可收班。