集成中心-API集成介绍
功能概述
在集成中心的API集成模块，可以统一管理第三方API的鉴权认证配置和API接口的请求配置，经过授权的应用都可以直接调用配置好的API来获取数据或推送数据。
除了自定义配置接口外，在API库中，平台还预置了100多个常用的API模板，组织管理员也可以将自定义的连接添加到组织下的API库。
入口
在平台主页，点击左侧导航栏下方的“集成中心”按钮，进入集成中心管理页面。
API集成分两个模块：
我的链接
在这里可以创建第三方API的连接并保存鉴权认证、配置接口请求信息和授权给相关应用。
API库
公共库： 由平台预设的API链接模板，可以直接安装使用，但是API连接配置不能更改，只能填充参数。
组织库： 组织管理员可以将组织内创建的API链接添加到组织库，其他成员可以申请使用。
使用流程简述
第1步、配置第三方API的鉴权认证信息
一个服务商可能有多个接口提供不同的服务，但是获取身份认证信息基本是通用的，例如获取token，只需获取一次，有效期内可以调用多个接口，在集成中心统一配置后，相关接口都可以直接使用此认证信息。
有些服务商的API接口不需要先获取认证信息，则可以跳过此步，直接配置第2步。
第2步、配置API接口请求信息
使用不同的数据服务就需要调用不同的接口，每个接口都需要配置相关输入参数，接口地址。对于获取到数据，需要配置数据的输出格式，供工作表或工作流使用。
第3步、将接口授权给相关应用
只有获得授权的应用，才能使用集成好的API接口。
第4步、调用集成API
以下3处可直接调用配置好的连接认证或API接口
- 工作表的API查询字段
- 工作流的[调用已集成 API]节点，可以直接使用集成中心里的配置好的API
- 工作流的[ API认证与连接 ] 节点，可以直接使用集成中心里的「连接与认证」
安装预置API快速体验功能
在API库中，内置了30种常用API服务，您可以根据需要直接安装，安装后，连接认证以及API接口等相关信息都配置好，您只需填写和配置必要的参数值即可。
我们以[天眼查]为例，介绍下安装和使用过程。
1、安装目标API
进入集成中心后，点击[天眼查]，会详细介绍相关接口服务，然后点击安装。
2、配置连接信息
界面中出现了需要token的信息，需要我们前往[天眼查]网站注册服务，申请接口并获取到这个token，然后填写进来保存即可。天眼查的token信息获取可参考：如何获取token
3、启用需要的API
一个服务商的连接可以有多个接口服务，找到需要的接口开启即可
4、授权给需要的应用
只有添加了授权的应用，才能使用此连接服务和API功能。
5、工作表中使用集成API
进入CRM应用，添加API查询字段和工商信息相关的字段。
功能效果
第一步、连接与认证
上一章我们通过安装预置API模板，了解了使用过程。本章我们详细介绍从0开始配置自定义连接的操作过程。
添加自定义连接
进入集成中心后，切换到[我的连接]，点击+自定义连接
选择鉴权方式
根据所需API服务的鉴权要求，选择对应的鉴权方式，如果不需要或者在请求URL中进行API Key鉴权，则直接点击[APIKey或无需鉴权无需认证]，选择后点击保存并继续。
连接参数
连接参数是配置鉴权时依赖的一些身份参数，比如企业微信中要获取Token时需要corpid和corpsecret，这些参数服务服务商都会分配给我们，我们只需粘贴到此处即可，如果API接口不需要，连接参数可以不配置。
在API服务商系统内获取到相关信息后，填充到对应的参数值然后保存即可（安装的API服务，只能填写参数值，不能改参数名等信息）
参数值可以选择隐藏显示，勾选隐藏后，参数值加密显示，不允许取消隐藏
参数值隐藏后，只能修改，不能再显示，需要查看需到服务商平台查看
连接参数 除了获取Token时可能需要，在调用API时请求参数也可能需要，因此，服务商的基础应用信息都可以填写在这里供鉴权认证使用或API请求时使用。
Basic Auth 认证
此方式表示每次请求API时都需要提供用户的username和password。
用户名和密码可以在这里直接写固定值，也可以从配置好的连接参数中选择。
OAuth 鉴权认证
通过此方式可以获取到的Access Token，供API请求时使用。
- 默认生成 app_id 和 app_secret 两个param参数；可以更改或删除
- 参数值可以从连接参数中选择
- 配置完毕后点击[获取Access Token]按钮，测试
- 根据API服务要求，可以配置过期时长，到时自动获取新Token。
配置连接的基本信息
可以设置连接的名称、Logo、和描述
第二步、API接口请求配置
连接认证配置完成后，就可以开始配置相关的API请求了。 切换到[API管理]，点击创建API按钮开始配置。
主要配置基本信息、输入参数、API请求参数和输出参数，以及使用代码块来个性化处理输入和输出参数。
API基本信息
点击相关位置，可以设置API的名、描述说明、图标和颜色
输入参数
输入参数用于在工作表或工作流中使用 API 查询时，可以传入动态值。传进来后，可以将此参数值再传给API请求参数。
参数默认值
如果参数为非必填，且传进来的为空值，则使用默认值（如果有）。
必填参数一定会有值传进来，不需要设置默认值，但也支持设置（取消必填时可用）
参数格式规则和要求
参数类型：文本、数值、日期时间、人员、部门、附件、数组、对象数组；
附件字段中无论有多少个文件，传入的的数组，格式如下。
["URL1","URL2","URL3"...]， 如果需要URL字符串，则使用代码块处理后再传入API请求参数。
必填的参数在工作表和工作流中使用此API时传入的参数不能为空；
对象数组的必填验证规则：
- 对象数组必填，则在使用时必须传入该数组；对象数组不必填，则在使用时该数组可以不传入；
- 对象数组必填且子元素没有设置必填项，则在使用时允许传入的数组为空数组；
- 对象数组必填且子元素有必填项，则在使用时会验证传入的子元素是否有值；
- 对象数组不必填但子元素有必填项，则未传入对象数组时不验证子元素是否有值，该数组传了值之后，则需要验证必填的子元素项是否有值；
别名规则：仅支持字母、数字、下划线、短横线（减号）
在发送API请求时，数组对象子元素将以别名作为key
参数支持默认值
插入代码
当传入的参数格式或数据不符合API参数要求时，可以通过代码处理后再传递给API参数。也可以将API返回的结果经常代码处理后再输出。
支持 Javascript和Python语言。
常见场景有：
结合时间戳、密钥等加密后获取Token
传递手机号时去掉 +86
传递附件图片时传递URL字符串
将API返回的数据封装为JSON数组并输出返回
从API返回的JSON数据中进行处理后输出返回
API请求配置
在这里配置发送 API 请求时需要的URL、 Query Param、Header、Body 等请求参数。
请求中的参数值可以选择[连接参数]和[输入参数]、[鉴权认证]3个地方的动态值。
配置完毕后，点击[测试API]，输入测试参数，即可返回请求的数据。
相关配置信息介绍，可参考发送API请求介绍
输出参数
在API执行请求后，将获取到的数据格式化输出，以便被工作表字段或被工作流节点引用。
其依据的示例数据是上一步测试时返回的响应Body中的数据。
输出配置方法： 使用JSON解析后将需要的内容添加到参数中。JSON解析
发布API
输出参数配置完毕后，就可以发布API了。发布后才能被应用的工作表或工作流调用。
添加更多API接口
一个连接认证内，可以添加多个API接口请求，这些API接口共用用同一个连接。
第三步、授权给应用
集成中心配置好的API，需要配置连接的拥有者，错误提醒机制和授权应用，获得授权才能直接调用。
切换到[授权到应用]栏位下，可以进行操作操作。
拥有者
连接的拥有者可以修改和查看连接的配置，可以接收错误消息。
发送错误消息
如果调用时出现错误，是否向拥有者发送消息，如果发送，可以配置发送消息类型，如果是相同类型消息则多久才通知一次，不需要次次提醒，造成干扰。
授权应用
只有本组织的应用才能添加授权，授权后，应用下的工作表和工作流可以调用API。
第4步、如何调用集成API
具体请参考相关介绍
连接和API管理
连接管理
在[我的连接]下，会列出所有创建的连接，包括未完成配置的连接。组织管理员可管理员组织下所有的连接
点击连接名称，进去此连接的管理页面，可以删除连接或申请上架的API库，可以继续配置API和授权。
连接中的API管理
在连接的API管理栏目下，可以管理此连接下的所有API，可以开启停用API。
点击某个API，可以进一步查看和管理此API的信息。
查看引用
可以看到此接口被哪些工作表和工作流引用。点击工作表/工作流名称可以直接打开对应的编辑页面。
请求日志
可以查看所有引用此 API 发送的请求日志。 无权限人员不能查看日志。
请求参数示例：
返回结果示例
文档问题反馈
文档中是否有错别字、内容过期、难以理解等问题？ 点此给我们反馈吧