@ celigo/ 图片
OpenAPI 3.2 规格 Celigo 整合器.io 爱普, 被打包为工具文件 。 他们是背后的文件 Celigo 开发者平台上的 API 引用, (中文(简体) ), 还有什么 西丽戈CLI 对资源文档进行校验.
npm install @celigo/api-specs
包裹里有什么
每个平台资源都有自己的 OpenAPI 文件 dist/ - 连接、流动、出口、,
进口、集成、工作、脚本、工具以及其他。 每个文件都是自成一体的,每个文件
$ref ,因此可以直接进入客户端生成器、请求验证器或
AI代理的上下文没有加载器配置.
dist/connection.yml
dist/flow.yml
dist/export.yml
dist/import.yml
...
schemas.json
schemas.json 是西里戈CLI的图案 celigo lint 命令验证文档
反之,由同捆所编. 其他消费者可以忽略它.
以与其它已打包文件相同的方式解决文档 :
import { createRequire } from "node:module";
const require = createRequire(import.meta.url);
const specPath = require.resolve("@celigo/api-specs/dist/connection.yml");
API 这些规格描述
所有行动都在 /v1/ 前缀并用无记名符号认证
(单位:千美元)Authorization: Bearer <token>) (中文(简体) ). 在下方创建符号集成.io 资源 > 翻译:
API 令牌。 。 。 .
API服务于四个区域主机. 用你的账户里住的那个:
| 地区 | 基础 URL |
|---|---|
| US( 默认) | https://api.integrator.io |
| 欧盟 | https://api.eu.integrator.io |
| 非盟 | https://api.au.integrator.io |
| 加利福尼亚 | https://api.ca.integrator.io |
API 管理(/v1/apim/...)只服务于美国和欧盟的东道主.
要交互浏览 API,请使用 参考文献: 每个资源都有自己的资源 页面,并设有一个控制台,用于对自己的账户进行呼叫.
说明什么
规格为规范. 他们描述API表面 Celigo 支持并打算保留 支持 —— 不是服务器碰巧容忍的一切. 内部终点,被侵蚀的田地, 和已退休的元素值被故意忽略.
实际后果: 一个针对这些规格的请求是您可以借鉴的. 反之则不行. 服务器可能接受无说明的有效载荷,该有效载荷可能 后被忽略或拒绝.
扩展
除了标准的 OpenAPI 外,文档还带有 x- celigo工具读取的扩展 。 标准
OpenAPI 消费者可以忽略它们;验证器和AI代理可能发现它们有用.
| 延长 | 何处 | 含义 |
|---|---|---|
x-enumDescriptions | 字段为 enum | 解释它的作用. |
x-celigo-refModel | 标识字段 | 资源类型 ID 点 flows, (中文(简体) ), scripts,等等). |
x-celigo-ai-guidance | 外观和外观 | 对AI代理的操作提示:默认选择哪个,脚手架设置时设置什么,以及错误导致的具体故障. |
x-celigo-ui-override | 外观和外观 | 标出一个可以反射成像器.io形式的要求或默认,它比原始的API更严格,因此所生成的配置是完整而可连接的. |
x-celigo-agent | 表达字段 | 字段值以表达式语言或编辑器编写;其能力标记(handlebars, (中文(简体) ), sql, (中文(简体) ), mapping,...)告诉代理或工具哪个. |
x-celigo-handlebars-context | 处理栏字段 | 用于评价表达式的数据背景,例如: pre-mapped 或者说 post-mapped。 。 。 . |
x-celigo-excludeAdaptorTypes | 共享适配器字段 | 该字段不适用的适配器类型 . |
x-lowercase, (中文(简体) ), x-uppercase | 字符串字段 | API 将值的大小写规范化 . |
x-internal, (中文(简体) ), x-enable-proxy,以及 x-displayName 控制文档工具链并携带无
API意义.
支助
对于规格的问题——与API不一致的策略,缺失的字段或终点,a 或与integrator.io本身联系 Celigo 支持。最有用的报告名称为 光谱和操作,显示您提出的要求,并显示 API 返回到旁边 spec说它会。 永不包含API令牌,证书,或客户数据.
私人通过同一渠道报告疑似安全薄弱之处,包括: 涉及操作、它披露或促成什么以及复制步骤.
许可证
麻省理工学院. 这个 LICENSE 备案船在包裹。 规格描述为集成器.io API;使用
API本身受你的西里戈协议管辖.