全部产品

HTTP API

快速开始指导您快速注册并发布一个供移动端调用的 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 分组列表页。
  2. 点击 创建 API 分组 按钮,在弹出的对话框中填写 API 分组信息。
    1
    • 分组类型:选择 HTTP。
    • API 分组:必填,填写服务的业务系统的英文名称。
    • 跨 VPC HTTP:是否允许跨 VPC 服务调用。若打开该开关,则表示允许跨 VPC 服务调用。
      该功能针对 MGS 服务所在的专有网络 VPC 与用户自己的服务所部署的 VPC 非同一网络环境,通过 MGS 调用后端服务时需要跨 VPC 的场景。
      说明:目前仅上海金融区环境提供跨 VPC HTTP 功能。
      启用跨 VPC HTTP 调用功能,还需完成以下配置:
      • 是否支持 HTTPS:MGS 提供通过负载均衡(SLB)HTTPS 监听转发来自 HTTPS 协议的请求的能力,以满足数据加密传输的应用场景。默认支持 HTTPS,如无需使用 HTTPS 域名,选择 即可。
      • HTTPS 域名:仅当选择支持 HTTPS 时需要配置,对应 SLB 上挂载的证书域名。
      • VPC Id:对应服务部署的 ECS 的专有网络或 SLB 实例的所属网络。
      • 实例 IP 或地址:对应服务部署的 ECS 的主私网 IP 信息或 SLB 实例的 IP 地址。
      • 端口号:服务端口号。
        注意
        • 目前 MGS 不支持自签证书,使用跨 VPC HTTPS 时,需要配置 CA 认证证书域名,否则会导致域名解析失败。
        • 单独使用 ECS 配置后端服务时,需要开放 ECS 的安全组端口,避免安全策略拦截。相关端口 IP 信息,请 提交工单 联系技术支持人员获取。
        • 仅支持同地域(Region)的跨 VPC 访问,不支持跨地域的 VPC 访问,例如部署在杭州的服务无法调用上海的服务。同时,地域区分金融区和非金融区,例如杭州金融区和杭州非金融区视作不同地域。
        • 同时使用 SLB 和 ECS 配置后端服务时,需要确保 SLB 和 ECS 在相同的 VPC 内,即服务部署的 ECS 专有网络信息与 SLB 实例的所属网络信息保持一致。
        122
    • 服务地址:业务系统的 HTTP/HTTPS URL。未开启跨 VPC HTTP 功能时需要配置该项。
    • 超时时间:选填,发送请求至业务系统时的超时时间,单位毫秒,默认值:3000 ms。
  3. 完成 API 分组信息配置后,点击 确定 完成分组创建。

如需进一步完善 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 服务即可供客户端调用。有关客户端开发的更多信息,参见下列 客户端开发指南