用途:为在 Domo Custom Connector IDE 中开发自定义连接器(数据连接器或回写连接器)提供开发规则与常见模式,用于将外部 API 与数据源接入 Domo。连接器发布后在服务端运行。
前提:需要能访问 Domo Custom Connector IDE,了解所对接的外部 API,并具备 JavaScript 知识(连接器以 JavaScript 编写)。
文件结构:连接器由若干 JavaScript 文件组成。authentication.js 负责校验凭据并与外部 API 认证;dataProcessing.js 负责抓取并处理外部 API 数据;README.md 记录连接器可用的报表与参数。所有文件使用 .js 后缀。
主要能力与模式:认证部分先校验输入格式,例如用 /^[a-zA-Z0-9_-]+$/ 测试 token,通过后添加 Accept 与 Authorization 头并调用测试接口,根据状态码调用 auth.authenticationSuccess() 或 auth.authenticationFailed()。数据处理部分根据 metadata.report 选择端点,用 do…while 循环配合响应中的分页链接实现翻页,状态码非 200 时抛出错误,再用 datagrid.magicParseJSON(responseData.results) 将 JSON 数组解析为 Domo 数据集。错误处理中解析响应体取出错误消息,失败时抛出带状态码或响应片段的 Error。
使用方式:按上述模式编写 authentication.js 与 dataProcessing.js,在 IDE 中开发并通过后发布,连接器即在服务端运行。Domo 在 Connector Dev Studio 中提供 JavaScript 库方法,可参考 https://developer.domo.com/portal/e415bb99d21b3-reference。
限制与注意事项:该技能仅适用于 Domo Custom Connector IDE 项目,不适用于 Domo App Platform 自定义应用或卡片构建。需始终对输入(如 API 密钥)做净化以防跨站脚本与 SQL 注入;数据集中每行列数必须一致,缺失值用 null;JSON 数组应使用 datagrid.magicParseJSON() 而非手动解析;认证失败信息在 auth.authenticationFailed() 中要清晰可操作。资料未提供收费、价格、平台支持范围等进一步信息。