API网关 APIGAPI网关 APIG

文档首页> API网关 APIG> 用户指南> 调用API> 应用管理> 为简易认证添加AppCode
更新时间:2021/09/27 GMT+08:00
分享

为简易认证添加AppCode

操作场景

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

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

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

前提条件

已创建应用。

生成AppCode

  1. 登录管理控制台。
  2. 在管理控制台左上角单击,选择区域。
  3. 单击管理控制台左上角,然后单击“API网关 APIG”。
  4. 在左侧选择您的API版本,单击并进入到对应版本的API开发与调用管理页面。

    • “共享版”指直接创建并管理API,如涉及到费用,以API调用次数计费。
    • “专享版”指在API专享版实例中创建并管理API,如涉及到费用,按实例运行时间计费。

  5. 选择“调用API > 应用管理”,进入到应用管理信息页面。
  6. 单击待查看的应用名称,进入应用详情页面。
  7. 单击“AppCode”页签,进入AppCode的管理界面。
  8. 单击“添加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"

分享:

    相关文档

    相关产品