API自定义验证

API管理提供API自定义验证,使第三方API提供者,通过自定义Lua脚本的方式,定义验证三方API,调用三方自提供的验证服务,并返回验证结果。进而继续后续的API业务流程。

自定义验证中配置自定义的认证函数,API管理可通过此函数对接后端认证系统,获取后端服务的访问授权,并将验证结果返回至API管理。

任务描述

本文介绍了进行API自定义验证的步骤。

开始前准备

  • 拥有一个EnOS账号,并拥有定义API操作需要的相应权限,参考策略,角色,与权限
  • 已经完成了发布API,当完成API发布后,你可以授权API被调用。

步骤

  1. 选择 API管理 > 自定义验证, 点击 创建自定义验证,在弹框中验证名称、验证脚本等信息,点击保存,即创建自定义验证成功;

    ../_images/custom_verification.png
  2. 在自定义验证列表中,修改新创建的自定义验证,可通过列表操作栏的 查看 按钮进入详情页进行修改自定义验证参数,可以直接点击 编辑 按钮,在弹窗内修改自定义验证参数;

    • 编辑:选择 编辑 ,修改自定义参数或验证脚本。
  3. 绑定API,可通过列表操作栏的 查看 按钮进入详情页添加绑定API,也可以直接点击 绑定API 按钮,在弹窗内搜索需要绑定的API并勾选保存。

  4. 创建自定义验证成功并绑定API后,API调用时在API管理中执行自定义的验证逻辑。

注解

一个自定义验证可以绑定多个API,但是每个API只能绑定到一个自定义验证。