全部产品

HTTP API

更新时间:2021-04-26 18:41:01

快速开始指导您快速注册并发布一个供移动端调用的 HTTP 类型的 API 服务。整体过程分为五步:

  1. 注册 API 分组
  2. 注册 API 服务
  3. 配置 API 服务
  4. 测试 API 服务
  5. 生成客户端 SDK

准备

  1. 登录控制台,在 产品与服务 中选择 移动开发平台 mPaaS 进入移动开发平台主页。
  2. 切换至正确的工作空间后,单击需要接入 API 服务的 App 名称。
  3. 在左侧导航栏选择 移动网关,进入移动网关配置页面。

注册 API 分组

只有先注册了 API 分组,在后续创建完 API 并对其进行配置时,才可在 接入系统 中选择已创建的 API 分组,详见 配置 API 服务 中的截图。

  1. 选择 API 分组 选项卡进入 API 分组列表页,单击 创建 API 分组 按钮。
  2. 在弹出的对话框中填写表单信息。

    • 分组类型:默认为 HTTP。
    • API 分组:必填,提供服务的业务系统的名称,由字母或下划线开头,只支持字母、数字、下划线以及连字符。
    • 服务地址:必填,业务系统的 HTTP/HTTPS URL。
    • 超时时间:选填,发送请求至业务系统时的超时时间,单位毫秒;默认值为 3000 ms。
  3. 单击 确定 按钮提交。
    如需进一步完善 API 分组 相关配置,请参考 配置 API 分组

注册 API 服务

  1. 选择 API 管理 选项卡进入 API 列表页,单击 创建 API 按钮。
  2. 在弹出的对话框中填写 API 信息。

    • API 类型:默认为 HTTP。
    • 添加方式:目前只支持手动方式注册 HTTP API。
    • operationType:必填,当前环境和应用下 API 服务唯一标识。命名规则为 组织.产品域.产品.子产品.操作
  3. 单击 确定 按钮提交。

配置 API 服务

  1. API 管理 选项卡中,单击 API 列表操作列中的 配置,进入 API 配置页面。
  2. 在 API 配置区域,单击 修改 按钮进行相应参数的编辑;修改完成后,单击 保存 按钮。
    config_api

    说明
    • 为了快速入门,您可以先将 高级配置 中的 签名校验 关闭。关于签名校验的详细信息,请参考 签名校验说明
    • 关于 API 配置的详细信息,请参考 API 配置
  3. 打开右上方开关,使 API 服务处于 开通 状态。只有处于开通状态的 API 服务才能被调用。

测试 API 服务

相关信息请参考 API 测试

生成客户端 SDK

相关信息请参考 代码生成

结果

完成上述几步操作,API 服务即可供客户端调用。有关客户端开发的更多信息,参见下列 客户端开发指南