更新时间:2026-07-10 GMT+08:00
分享

为API添加简易认证凭据

简易认证指在调用API时,HTTP请求头部消息增加一个参数X-Apig-AppCode(参数值填凭据详情中“AppCode”的值),而不需要对请求内容签名,APIC也仅校验AppCode,不校验请求签名,从而实现快速响应。

若API开启了简易认证,可直接使用凭据中配置的AppCode进行简易安全认证,无需使用Key和Secret进行认证。

注意事项

简易认证方式不需要复杂的签名过程,但是AppCode在网络传输过程中使用明文,会带来一些安全隐患,请勿携带隐私信息,谨慎操作。

约束与限制

仅安全认证方式为“APP认证”的API支持简易认证。

每个凭据最多可创建5个AppCode。

前提条件

已创建APP认证类型的API,并且开启简易认证模式。如果您在已有API上开启简易认证,需要在开启后,将API重新发布,使简易认证模式生效。

生成AppCode

  1. 登录ROMA Connect控制台,在左侧导航栏选择“资源管理”,在实例页面单击实例,进入实例控制台。
  2. 在左侧的导航栏选择“服务集成 APIC > 凭据管理”,在“凭据管理”页签中单击API所授权凭据的名称,进入凭据详情页面。
  3. 在页面的“AppCodes”下,单击“添加AppCode”。
  4. 在添加AppCode弹窗中配置AppCode。
    表1 AppCode配置

    参数

    说明

    生成方式

    选择AppCode的生成方式。

    • 自动生成:由系统随机生成AppCode。
    • 手动输入:自定义AppCode。

    AppCode

    仅当“生成方式”选择“手动输入”时需要配置。

    填写AppCode的值。

    支持英文、数字、+_!@#$%-/=,且只能以英文、数字和+、/开头,长度为64~180个字符。

  5. 完成后单击“确定”。
  6. AppCode添加完成后,您可以使用AppCode进行API请求的简易认证。

    发送请求时,增加请求头部参数“X-Apig-AppCode”,省略请求签名相关信息。

    以Curl方式为例,增加头部参数名称:X-Apig-AppCode,参数值填已生成的AppCode。

    curl -X GET "https://api.exampledemo.com/testapi" -H "content-type: application/json"  -H "host: api.exampledemo.com" -H "X-Apig-AppCode: xhrJVJKABSOxc7d***********FZL4gSHEXkCMQC"

绑定API/授权API

绑定API或授权API就是将API与凭据关联起来,APIC可以根据凭据的密钥对进行身份鉴权,调用关联的API。

绑定API

  1. 在“凭据管理”页面,单击凭据名称,进入详情页面。
  2. 在“关联API”区域,单击“绑定API”。
  3. 选择授权环境、API分组和API。
  4. 单击“确定”。

    如需解绑API,在API所在行单击“解绑”即可。

授权API

  1. 在左侧导航栏选择“服务集成 APIC > API分组”。
  2. 单击分组名称,进入“分组信息”页面。
  3. 在“API运行”页面,选择待授权的API,单击“更多 > 授权”。
  4. 单击“添加授权”。
  5. 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。

    如果已授权的凭据需要解除授权,在凭据列表中凭据所在行单击“解除授权”。

相关文档