输入提示

##产品介绍##{#title:introduce}输入提示是一类简单的HTTP接口，提供根据用户输入的关键词查询返回建

源代码编辑器
<div class="md-container"><h2 data-anchor="introduce" id="introduce">产品介绍</h2><p>输入提示是一类简单的HTTP接口，提供根据用户输入的关键词查询返回建议列表。</p><p>使用API前您需先<a href="https://lbs.amap.com/dev/key" class="" target="_blank">申请Key</a>，若无高德地图API账号需要先申请账号。</p><h2 data-anchor="scene" id="scene">适用场景</h2><p>在高德客户端的使用场景，输入“仙林”之后出现提示相关。</p><p><br></p><div class="md-atomic"><img src="https://a.amap.com/lbs/static/img/webAPIsug.png" width="400" alt=""></div><p><br></p>
<p><br></p><p><br></p>
<p><br></p><p><br></p><h2 data-anchor="limit" id="limit">使用限制</h2><p>&nbsp;服务调用量的限制请点击<a href="https://lbs.amap.com/api/webservice/guide/tools/flowlevel" class="" target="_blank">这里</a>查阅。&nbsp;&nbsp;</p><h2 data-anchor="instructions" id="instructions">使用说明</h2><p>第一步，申请”Web服务API接口”密钥（Key）；</p><p>第二步，拼接HTTP请求URL，第一步申请的Key需作为必填参数一同发送；</p><p>第三步，接收HTTP请求返回的数据（JSON或XML格式），解析数据。</p><p>如无特殊声明，接口的输入参数和输出数据编码全部统一为UTF-8。</p><h2 data-anchor="inputtips" id="inputtips">输入提示</h2><p>输入提示API服务地址：</p><div class="md-atomic"><div class="table-container" style="width:70%;"><table class="md-table common " data-meta="%7B%22width%22%3A%2270%25%22%2C%22type%22%3A%22common%22%7D"><tbody><tr><td style="white-space:nowrap;"><p>URL</p></td><td><p>https://restapi.amap.com/v3/assistant/inputtips?parameters</p></td></tr><tr><td style="white-space:nowrap;"><p>请求方式</p></td><td><p>GET</p></td></tr></tbody></table></div></div><p><em>parameters</em>代表的参数包括必填参数和可选参数。所有参数均使用和号字符(&amp;)进行分隔。下面的列表枚举了这些参数及其使用规则。</p><ul>
  <li><strong>请求参数</strong></li></ul><div class="md-atomic"><div class="table-container" style="width:100%;"><table class="md-table  " data-meta="%7B%22width%22%3A%22100%25%22%7D"><tbody><tr><th colspan="2" style="white-space:nowrap;"><p>参数名</p></th><th><p>含义</p></th><th><p>规则说明</p></th><th style="white-space:nowrap;"><p>是否必须</p></th><th><p>缺省值</p></th></tr><tr><td colspan="2" style="white-space:nowrap;"><p>key</p></td><td><p>请求服务权限标识</p></td><td><p>用户在高德地图官网<a href="https://lbs.amap.com/dev/" class="" target="_blank">申请Web服务API类型KEY</a></p></td><td style="white-space:nowrap;"><p>必填</p></td><td><p>无</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>keywords</p></td><td><p>查询关键词</p></td><td><p><br></p></td><td style="white-space:nowrap;"><p>必填</p></td><td><p>无</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>type</p></td><td><p>POI分类</p></td><td><p>服务可支持传入多个分类，多个类型剑用“|”分隔</p><p>可选值：POI分类名称、分类代码</p><p>此处强烈建议使用分类代码，否则可能会得到不符合预期的结果</p></td><td style="white-space:nowrap;"><p>可选&nbsp;</p></td><td><p>无</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>location</p></td><td><p>坐标</p></td><td><p>格式：“X,Y”（经度,纬度），不可以包含空格</p><p>建议使用location参数，可在此location附近优先返回搜索关键词信息</p><p>在请求参数city不为空时生效</p></td><td style="white-space:nowrap;"><p>可选&nbsp;</p></td><td><p>无</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>city</p></td><td><p>搜索城市</p></td><td><p>可选值：citycode、adcode，不支持县级市。</p><p>如：010/110000</p><p>adcode信息可参考<a href="https://lbs.amap.com/api/webservice/download" class="" target="_blank">城市编码表</a>获取。</p><p>填入此参数后，会尽量优先返回此城市数据，但是不一定仅局限此城市结果，若仅需要某个城市数据请调用citylimit参数。</p><p>如：在深圳市搜天安门，返回北京天安门结果。</p></td><td style="white-space:nowrap;"><p>可选&nbsp;</p></td><td><p>无（默认在全国范围内搜索）</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>citylimit</p></td><td><p>仅返回指定城市数据</p></td><td><p>可选值：true/false</p></td><td style="white-space:nowrap;"><p>可选</p></td><td><p>false</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>datatype</p></td><td><p>返回的数据类型</p></td><td><p>多种数据类型用“|”分隔，可选值：all-返回所有数据类型、poi-返回POI数据类型、bus-返回公交站点数据类型、busline-返回公交线路数据类型</p></td><td style="white-space:nowrap;"><p>可选&nbsp;</p></td><td><p>all</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>sig</p></td><td><p>数字签名</p></td><td><p><a href="https://lbs.amap.com/faq/account/key/72" class="" target="_blank">数字签名获取和使用方法</a></p></td><td style="white-space:nowrap;"><p>可选</p></td><td><p>无</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>output</p></td><td><p>返回数据格式类型</p></td><td><p>可选值：JSON,XML</p></td><td style="white-space:nowrap;"><p>可选</p></td><td><p>JSON</p></td></tr><tr><td colspan="2" style="white-space:nowrap;"><p>callback</p></td><td><p>回调函数</p></td><td><p>callback值是用户定义的函数名称，此参数只在output=JSON时有效</p></td><td style="white-space:nowrap;"><p>可选</p></td><td><p>无</p></td></tr></tbody></table></div></div><ul>
  <li><strong>返回结果参数说明</strong></li></ul><p>输入提示的响应结果的格式由请求参数output指定。</p><div class="md-atomic"><div style="white-space:normal;"><table class="" border="1" cellspacing="0" cellpadding="0" bordercolor="#E6E6E6">
    <tbody>
        <tr bgcolor="#F2F2F2" class="firstRow">
            <th colspan="5" width="21%">
                <p>
                    名称
                </p>            </th>            <th width="164">
                <p>
                    含义
                </p>            </th>            <th width="NaN">
                <p>
                    规则说明
                </p>            </th>        </tr>        <tr>
            <td colspan="5" width="21%">
                <p>
                    status
                </p>            </td>            <td width="164">
                <p>
                    返回状态
                </p>            </td>            <td>
                <p>
                    值为0或1<br>
                    1：成功；0：失败
                </p>            </td>        </tr>        <tr>
            <td colspan="5" width="21%">
                <p>
                    info
                </p>            </td>            <td width="164">
                <p>
                    返回的状态信息
                </p>            </td>            <td width="NaN">
                <p>status为0时，info返回错误原；否则返回“OK”。详情参阅<a href="https://lbs.amap.com/api/webservice/guide/tools/info/" target="_blank"><span class="blue">info状态表</span></a></p>            </td>        </tr>        <tr>
            <td colspan="5" width="21%">
                <p>
                    count
                </p>            </td>            <td width="164">
                <p>
                    返回结果总数目
                </p>            </td>            <td width="NaN">
                <p>
                </p>            </td>        </tr>        <tr>
            <td colspan="5" width="21%">
                <p>
                    tips
                </p>            </td>            <td width="164">
                <p>
                    建议提示列表
                </p>            </td>            <td width="NaN">
                <p>
                </p>            </td>        </tr>        <tr>
            <td rowspan="12"></td>            <td colspan="4" width="17%">
                <p>
                    tip
                </p>            </td>            <td width="164">
                <p>
                    提示信息
                </p>            </td>            <td width="17">
                <p>
                </p>            </td>        </tr>        <tr>
            <td rowspan="12"></td>            <td colspan="3" width="15%">
                <p>
                    id
                </p>            </td>            <td width="164">
                <p>
                    返回数据ID
                </p>            </td>            <td width="NaN">
                <p>
                若数据为POI类型，则返回POI ID;若数据为bus类型，则返回bus id;若数据为busline类型，则返回busline id。
                </p>            </td>        </tr>        <tr>
            <td colspan="3" width="15%">
                <p>
                    name
                </p>            </td>            <td width="164">
                <p>
                    tip名称
                </p>            </td>            <td width="NaN">
                <p>
                    
                </p>            </td>        </tr>        <tr>
            <td colspan="3" width="15%">
                <p>
                    district
                </p>            </td>            <td width="164">
                <p>
                    所属区域
                </p>            </td>            <td width="NaN">
                <p>
                    省+市+区（直辖市为“市+区”）
                </p>            </td>        </tr>        <tr>
            <td colspan="3" width="15%">
                <p>
                    adcode
                </p>            </td>            <td width="164">
                <p>
                    区域编码
                </p>            </td>            <td width="NaN">
                <p>
                    六位区县编码
                </p>            </td>        </tr>        <tr>
            <td colspan="3" width="15%">
                <p>
                    location
                </p>            </td>            <td width="164">
                <p>
                    tip中心点坐标
                </p>            </td>            <td width="NaN">
                <p>
                    当搜索数据为busline类型时，此字段不返回
                </p>            </td>        </tr>        <tr>
            <td colspan="3" width="15%">
                <p>
                    address
                </p>            </td>            <td width="164">
                <p>
                    详细地址
                </p>            </td>            <td width="NaN">
                <p>
                    
                </p>            </td>        </tr>        
    </tbody></table></div></div><ul>
  <li><strong>服务示例</strong></li></ul><pre><code>https://restapi.amap.com/v3/assistant/inputtips?output=xml&amp;city=010&amp;keywords=招商银行&amp;key=&lt;用户的key&gt;</code></pre>
<div class="md-atomic"><div><!--component:8--></div></div><p><br></p></div>
控制台
清空
返回顶部示例中心常见问题智能客服公众号
二维码