本文介绍调用 Mobile Use OpenAPI 的方法。对于具体的调用说明和参数说明，请查阅各 OpenAPI 文档。

前提条件

1. 通过火山引擎云手机控制台注册帐号，获取账号的 Access Key ID 和 Secret Access Key （AK/SK），用于 API 请求鉴权。详细步骤，参考 API 访问密钥使用指南。
2. 目前火山引擎云手机服务仅对企业用户开放，需完成企业实名认证。
3. 调用 Mobile Use OpenAPI 前，必须先访问跨服务访问请求为您的账号授权。

请求结构

调用 Mobile Use OpenAPI 是通过向指定服务地址发送请求，并需满足签名信息和具体接口的业务信息来完成的。OpenAPI 的请求需要包含服务地址、请求方式、请求参数等信息。接口调用成功后，对返回结果进行解析。

服务地址

open.volcengineapi.com

通信协议

Mobile Use OpenAPI 通信均采用 HTTPS 协议，确保数据传输的安全性和完整性，为您提供一个安全可靠的通信环境。

字符编码

请求及返回结果使用 UTF-8 的字符集进行编码。

请求方式

根据各个接口的具体需求，选择 GET 或 POST 方式发起请求。

请求参数

在发起请求时，请包含以下两类参数：

• 公共请求参数：所有接口调用时必须包含的参数。公共请求参数首字母均为大写，以此区分接口特有的请求参数。有关火山引擎 OpenAPI 公共参数的详细说明，请参考公共参数。
• 接口特定参数：各接口特有的业务参数。详情查阅各接口参数描述。

示例

以查询代理运行配置列表接口为例，一条未编码的 URL 请求示例如下：

https://open.volcengineapi.com?Action=ListAgentRunConfig
&Version=2023-08-01
&<通过header传入的公共请求参数>
&<请求体>

说明如下：

签名机制

对于每一次 HTTPS 协议请求，会根据访问中的签名信息验证访问请求者的身份。具体由用户的火山引擎账号对应的 Access Key ID 和 Secret Access Key（AK/SK）对称加密验证实现。具体的签名机制和方法，参考火山引擎 OpenAPI 签名方法。

返回结果

OpenAPI 请求可返回以下结果：

ResponseMetadata 结构体说明

Error 结构体说明