Auto-complete address interface

Use Google Places API for address auto-completion and configure the Google Places API Key in the system settings.

Request address

{域名地址}/api/place/autocomplete

Description:{域名地址}Replace it with your domain name, such ashttps://en.anqicms.com/api/place/autocomplete

Request Syntax

POST {域名地址}/api/place/autocomplete

Request Headers

This interface involves only public request headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Request parameters

Field name Type Required Description
input string Is search string entered by the user
languageCode string No language code, such as zh-CN
regionCode string No Country/Region code, such as CN
Included region codes array No List of specified country/region codes

Response header

This interface only involves common response headers. For more information, please refer toCommon Request Headers (Common Request Headers).

Return parameters

Field name Type Description
code int Error code
msg string Error description
data object The automatic completion result returned by Google Places API

Usage Example

Request example

POST /api/place/autocomplete HTTP/1.1
Host: your-domain.com
Content-Type: application/json

{
  "input": "Guangzhou",
  "languageCode": "zh-CN",
  "regionCode": "CN"
}

Response Example

{
  "code": 0,
  "data": {
    "suggestions": [
      {
        "place": {
          "formattedAddress": "Guangzhou, Guangdong, China",
          "displayName": {
            "text": "Guangzhou",
            "languageCode": "zh-CN"
          },
          "location": {
            "latitude": 23.1291,
            "longitude": 113.2644
          }
        }
      }
    ]
  },
  "msg": ""
}

error code

Error code Description
0 OK
-1 Error, the reason is indicated in msg