更新时间:2023-04-26 GMT+08:00

业务使用介绍

功能简介

服务集成APIC是ROMA Connect的API集成组件,支持将已有后端服务、数据源和自定义函数封装成标准的RESTful API,并对外开放。使用ROMA Connect进行服务集成,有如下优势:

  • 支持便捷的API生命周期管理

    ROMA Connect提供了API的全生命周期管理,从API的创建、调试、发布、下线、授权、编辑和删除等,实现完整的API解决方案。

  • 支持自定义API后端服务

    ROMA Connect可自定义数据后端和函数后端两种后端服务:

    • 数据后端:将数据源以API的形式对外开放,具体支持的数据源类型请参见APIC支持的数据源
    • 函数后端:将函数能力以API的形式对外开放。
  • 支持可视化的API监控面板

    ROMA Connect提供了可视化的API调用分析看板,帮助您监控API调用的性能指标信息,识别可能影响业务的潜在风险。

  • 支持多层安全防护措施

    ROMA Connect提供了多种认证鉴权方式、精细化的流量控制、严格的访问控制等安全防护措施,全方位保护API安全调用。

使用流程

使用ROMA Connect进行服务集成的流程如下图所示。

图1 业务使用流程
  1. 创建实例和集成应用
  2. 开放API
    • 开放API
      1. 创建API分组

        每个API都归属到某一个API分组下,在创建API前应提前创建API分组。

      2. 绑定域名

        在开放API前,您需要为API分组绑定一个独立域名,供用户访问API使用。

        在绑定独立域名前,您可以使用系统为API分配的默认子域名进行API调用测试,ROMA Connect对默认子域名的访问次数做了限制,每天最多可以访问1000次。

      3. 创建API

        把已有后端服务封装为标准RESTful API,并对外开放。

      4. 调试API

        通过ROMA Connect提供的调试功能,验证API服务的功能是否正常可用。

      5. 发布API

        把API发布到环境中,API只有在发布到环境后,才支持被调用。

      6. 配置API授权(可选)

        仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用,用户使用集成应用的Key和Secret进行API请求的安全认证。

    • 创建并开放数据API
      1. 接入数据源

        接入数据源,确保可以正常从数据源读取数据。

      2. 创建数据API

        把数据源定义为API,并对外开放。

      3. 配置API授权(可选)

        仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用,用户使用集成应用的Key和Secret进行API请求的安全认证。

    • 创建并开放函数API
      1. 创建函数API

        把自定义函数定义为API,并对外开放。

      2. 配置API授权(可选)

        仅使用APP认证方式的API,才需要配置调用授权,把API授权给指定集成应用,用户使用集成应用的Key和Secret进行API请求的安全认证。

  3. 调用API

    通过获取API及API访问地址,调用API。根据API使用认证方式的不同,调用API时需要进行不同的认证鉴权操作。