文档首页/ 云地图服务 KooMap/ API参考/ 如何调用API/ 构造请求
更新时间：2024-11-05 GMT+08:00
查看PDF
分享

构造请求

本节介绍REST API请求的组成，并以调用KooMap的AR导航接口说明如何调用API。

请求URI

请求URI由如下部分组成：

{URI-scheme}://{Endpoint}/{resource-path}?{query-string}

尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。

表1 URI中的参数说明

参数

描述

URI-scheme

表示用于传输请求的协议，当前KooMap所有API均采用HTTPS协议。

Endpoint

指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，当前KooMap只在“华北-北京四”部署，Endpoint为“koomap.cn-north-4.myhuaweicloud.com”。

resource-path

资源路径，即API访问路径。从具体API的URI模块获取，例如“AR导航”API的resource-path为“/v1/algo/navi”。

query-string

可选参数，用于查询指定参数数据。设置查询参数时，查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。

例如您需要获取KooMap在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（koomap.cn-north-4.myhuaweicloud.com），并在AR导航接口的URI部分找到resource-path（/v1/algo/navi），拼接起来如下所示。

https://koomap.cn-north-4.myhuaweicloud.com/v1/algo/navi

图1 URI示意图

为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法

HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。

表2 HTTP方法

方法

说明

GET

请求服务器返回指定资源。

POST

请求服务器新增资源或执行non-CRUD操作。

DELETE

请求服务器删除指定资源，如删除对象等。

PUT

请求服务器更新指定资源。

HEAD

请求服务器资源头部。

PATCH

请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。

在AR导航的URI部分，您可以看到其请求方法为“POST”，则其请求为：

POST https://koomap.cn-north-4.myhuaweicloud.com/v1/algo/navi

请求消息头

附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。

详细的公共请求消息头字段请参见表3。

表3 公共请求消息头

名称

描述

是否必选

示例

Content-Type

消息体的类型（格式），当前只支持application/json。

是

application/json

X-Auth-Token

用户Token。

用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。

请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。

是

使用Token认证时该字段必选。

注：以下仅为Token示例片段

MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

请求消息体（可选）

该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。

每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。

对于AR导航接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。

POST https://koomap.cn-north-4.myhuaweicloud.com/v1/algo/navi
Content-Type: application/json
X-Auth-Token：xxxxxxxx
{
  "domainId": "域id",
  "uuid": "用户唯一标识",
  "payload": {
      "utm": "地区UTM编码",
      "from": {
          "x": "起点位置x坐标",
          "y": "起点位置y坐标",
          "z": "起点位置z坐标"
      },
      "to": {
          "x": "终点位置x坐标",
          "y": "终点位置y坐标",
          "z": "终点位置z坐标"
      }
  }
}

到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

父主题： 如何调用API

相关文档