约 5 分钟完成

快速入门

从注册账号到完成第一次 API 调用,本指南将带你用最短的时间跑通全流程。

STEP 01

注册账号并获取 API Key

迈云位置服务采用 Bearer Token 鉴权。每个账号可创建多个 API Key, 支持按 Key 独立设置调用限额与权限范围。

  1. 1访问控制台,使用手机号或邮箱完成注册
  2. 2进入「密钥管理」页面,点击「新建密钥」
  3. 3填写密钥名称(如 test-key),确认后即可获取 API Key
  4. 4将密钥保存至安全位置,页面关闭后将不再展示完整密钥

安全提醒:请勿将 API Key 硬编码至前端代码或提交至公开代码仓库, 建议通过服务端环境变量注入,或使用后端代理转发 API 请求。

STEP 02

发起第一个 API 请求

正地址解析(Geocoding)为例, 将一段中文地址转换为经纬度坐标。这是最常见的使用场景之一。

POSThttps://lts.maiyun.net/api/service/geocoding查看完整文档 →
index.js
fetch('https://lts.maiyun.net/api/service/geocoding', {
    method: 'POST',
    headers: {
        'Authorization': 'Bearer YOUR_API_KEY',
        'Content-Type': 'application/json',
    },
    body: JSON.stringify({
        address: '北京市朝阳区望京街道',
    }),
})
    .then(res => res.json())
    .then(data => {
        const { lat, lng } = data;
        console.log('经纬度:', lat, lng);
    });

YOUR_API_KEY 替换为第 1 步获取的密钥, 然后将上方代码粘贴至浏览器控制台或 Node.js 环境中执行即可。

STEP 03

解析返回数据

所有接口均返回统一的 JSON 格式。result1 表示成功, 小于等于 0 表示错误, 错误描述在message 字段中说明。

字段类型说明
resultinteger状态码,1 表示成功,≤ 0 表示错误
latnumberGCJ02 纬度坐标,精确到小数点后 6 位
lngnumberGCJ02 经度坐标,精确到小数点后 6 位
address.namestring解析后的完整地址文本
address.contextarray行政区层级数组,每项含 type / name / code 字段

常见错误码:-400 未提供 Token;-401 Token 不存在或已过期;-429 请求频率超出限制;-1 参数缺失或格式错误。 详见各接口文档中的「错误码说明」章节。