API应用
更新时间:2024-08-28
API应用
创建应用
通过API网关创建应用,在API网关对该应用进行授权之后,可以通过应用来访问授权的API,应用有AppKey和 AppSecret的信息,在用户选用应用验证的时候,AppKey、AppSecret 用于计算签名。
操作步骤:
- 登录并进入API网关API GW。
- 在左侧导航栏,单击API网关-应用管理,应用管理文档。
- 单击创建应用。
- 然后填写创建应用的信息。
- 在应用创建完成之后,API网关会为应用自动生成AppKey和AppSecret,用于后续调用时计算签名。
表一 表单项说明
名称 | 描述 | 使用限制 |
---|---|---|
应用名称 | 应用名称 | 必填,支持汉字、英文字母、数字、英文格式的下划线,且必须以字母或汉字开始,长度限制为4~26个字符,1个中文占2个字符 |
描述 | 应用描述 |
授权API给应用
对于已经发布的API,是需要通过API网关应用来进行调用的,因此需要将API授权给对应的应用。
操作步骤:
- 登录并进入 API 网关 API GW。
- 在左侧导航栏,单击API网关-API列表,API 列表文档。
- 选择从 EDAP 数据共享中发布的 API。
- 单击 API 后的授权按钮。
- 选中授权环境、授权有效时间和授权应用。例如,将刚刚发布的 xwd_test_api_01 授权给应用 xwd_test_app。
- 在授权给应用之后,在应用管理中选择授权的应用可以查看已经授权的API列表。
绑定后端密钥
应用通过API网关进行调用EDAP查询数据时,需要通过后端密钥进行认证,因此还需要为API绑定后端密钥。
操作步骤:
- 登录并进入 API 网关 API GW。
- 在左侧导航栏,单击API网关>后端密钥管理,后端密钥管理文档。
- 选择创建好的后端密钥,单击绑定API。
- 在对话框中选择发布的 API,并单击确定。例如,将刚刚发布的 xwd_test_api_01 API 绑定后端密钥 xwd_test_sc。
- 在绑定完成之后,在后端密钥管理,单击该后端密钥,可以查询密钥下绑定的API列表。
通过API网关测试
通过 API 网关可以测试数据共享API是否已经可以成功调用。
操作步骤:
- 登录并进入API 网关 API GW。
- 在左侧导航栏,单击API网关-API列表,API列表文档。
- 单击对应的 API,然后单击调试API。
- 根据配置的参数列表,设置完参数,单击发送请求,可以查看查询结果。例如,这里测试了刚刚发布的 xwd_test_api_01 API。