文档首页/ API网关 APIG/ 用户指南/ 凭据管理/ 为简易认证绑定AppCode
更新时间:2024-07-29 GMT+08:00

为简易认证绑定AppCode

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

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

  • 为了确保安全,简易认证仅支持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的值。

使用AppCode进行API请求的简易认证

  1. 在创建API时,选择“APP认证”并且开启“支持简易认证”。

    如果您修改已有API为简易认证,需要在修改完成后,将API重新发布,使简易认证模式生效。

  2. 将支持简易认证的API绑定到已创建的凭据。
  3. 发送请求时,增加请求头部参数“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"