API授权

API 授权（API Authorization）是控制接口（API）访问权限的过程，旨在确保只有被授权的外部调用方才能够访问特定资源或执行特定操作。

目前，JitAi 支持使用 API 授权元素将系统中的服务函数对外开放。

API 授权的创建

在左侧元素树上点击+会打开弹窗，将鼠标移动到“更多”中，会看到“API 授权”。点击“API 授权”里面的“标准授权”，就会打开标准授权的新建弹窗页面。

在标准授权的新建弹窗页面中，填写 API 授权名称和 accessKey 后，点击保存即可创建一个新的 API 授权。

提示

accessKey 是 API 授权的密钥，是由 8-32 位字母或数字组成的字符串，不能包含特殊字符。

在创建 API 授权之前，系统会先根据 accessKey 生成 accessSecret。accessKey 和 accessSecret 是 API 授权访问的凭证。

API 访问权限控制

开发者可以将某些服务中的一些接口授权给调用方，调用方就可以通过调用 API 获取数据。

在开发者在新建 API 授权弹窗里点击确认后，页面会跳转到授权列表页面，并显示刚创建的授权信息。

在授权信息中的调用url就是授权接口的调用地址，调用方可以通过该 url 进行调用。

服务中的各个函数可以独立授权，在对应的接口名称前面打开授权状态开关即可，也可以点击右上角的全部授权将所有函数开放。

注意

在授权页面，开发者可以修改 accessKey。修改完 accessKey 后，请务必重新生成新的 accessSecret，否则校验将无法通过。

API 调用监控

当调用方发起调用时，JitAi 会生成调用记录。

在授权 API 的可视化编辑器中，点击右上角的调用记录，打开调用记录弹窗。

在调用记录弹窗中可以查看接口地址、调用时间、调用 IP、调用结果等信息，还可以根据调用结果状态、调用时间进行筛选。

使用SDK调用授权的接口

开发者配置好授权信息和授权接口后，调用方需使用 JitAi 提供的 SDK 进行使用。

JitAi 提供了 Python、Nodejs、Java 三种语言的 SDK。

在授权页面中点击下载SDK，可以查看SDK使用指南和下载地址。

使用跨App服务元素调用授权接口

如果调用方也是JitAi应用，则可以直接使用跨App服务元素调用授权方开放的接口。