文档首页/ API网关 APIG/ 用户指南/ 配置API调用授权（可选）/ 配置APIG的API简易认证AppCode
更新时间：2025-05-12 GMT+08:00
查看PDF
分享

配置APIG的API简易认证AppCode

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

当使用APP认证，且开启了简易认证模式，API请求既可以选择使用Key和Secret做签名和校验，也可以选择使用AppCode进行简易认证。

注意事项

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

前提条件

  • 已创建APP认证的API，并且开启简易认证模式。如未创建，请参考创建API。如果您在已有API上开启简易认证，需要在开启后，将API重新发布，使简易认证模式生效。
  • 已创建凭据，并且关联APP认证的API。如未创建，请参考配置APIG的API认证凭据。

约束与限制

  • 为了确保安全，简易认证仅支持HTTPS或GRPCS方式调用API，不支持HTTP。
  • 每个凭据最多可创建5个AppCode。

生成AppCode

  1. 进入API网关控制台页面。
  2. 根据实际业务在左侧导航栏上方选择实例。
  1. 在左侧导航栏选择“API管理 > 凭据管理”。
  1. 单击凭据名称，进入凭据详情页面。
  2. 在“AppCodes”区域，单击“添加AppCode”。
  3. 根据下表参数说明，在弹窗中配置AppCode。

    表1 配置AppCode

    参数

    说明

    生成方式

    选择AppCode的生成方式。

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

    AppCode

    仅手动输入方式需要填写AppCode的值。支持英文、数字、+_!@#$%-/=，且只能以英文、数字和+、/开头，长度为64~180个字符。

  4. 单击“确定”。
  5. 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"

相关文档

    OSZAR »