关于 pluggy-integration
一项用于集成 Pluggy Open Finance API 的参考技能。它按优先级整理身份验证、Connect Widget、Webhook、Item 生命周期和错误处理指南,并提供代码示例。
主要功能
- 01按优先级整理集成规则
- 02API 密钥与令牌指南
- 03Connect Widget 实现指南
- 04Webhook 和 Item 生命周期指南
- 05错误处理示例
适用场景
- 01配置 Pluggy SDK 身份验证
- 02在前端实现 Connect Widget
- 03管理 Item 和 MFA 流程
- 04配置 Webhook 并处理连接错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ pluggyai/ agent-skills --skill pluggy-integration安装后在 Claude Code 中输入/pluggy-integration确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonrules/auth-api-keys.mdauth-token-refresh.mderror-handling.mderror-mfa.mditem-delete.mditem-lifecycle.mdwebhook-setup.mdwidget-integration.mdwidget-update-item.md详细介绍
Pluggy 集成
Pluggy Open Finance API 的完整集成指南。包含 5 个类别的规则,并按影响程度排序,帮助实现准确的集成。
适用场景
在以下情况下参考这些指南:
- 配置 Pluggy SDK 和身份验证
- 在前端应用中实现 Connect Widget
- 创建、更新或管理 Item(连接)
- 处理 MFA(多因素身份验证)流程
- 配置 Webhook,实现实时数据同步
- 管理 API 密钥和令牌
- 处理连接错误和边缘情况
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 身份验证 | 严重 | auth- |
| 2 | Connect Widget | 严重 | widget- |
| 3 | Webhook 配置 | 严重 | webhook- |
| 4 | Item 生命周期 | 高 | item- |
| 5 | 错误处理 | 中 | error- |
使用方法
阅读各个规则文件,了解详细说明和代码示例:
rules/auth-api-keys.md
rules/widget-integration.md
rules/item-lifecycle.md
每个规则文件都包含:
- 简要说明规则的重要性
- 错误代码示例及说明
- 正确代码示例及说明
- 补充背景信息和参考资料
- Pluggy 专属说明
核心概念
连接同步与数据同步
| 职责 | 处理方 | 方式 |
|---|---|---|
| 连接同步 | Pluggy | 每 24/12/8 小时自动同步 |
| 触发更新 | 用户 | 仅在用户明确请求时触发 |
| 实体数据同步 | 你 | 在 item/updated Webhook 中获取全部数据 |
| 交易同步 | 你 | 使用 transactions/* Webhook 事件 |
API 密钥与 Connect Token
- API Key:用于访问用户数据的后端令牌(有效期 2 小时)
- Connect Token:仅供 Connect Widget 使用的前端令牌(有效期 30 分钟)
Item 生命周期
- 用户使用 Connect Token 打开 Connect Widget
- 用户选择连接器并进行身份验证
- Pluggy 创建 Item 并开始数据同步
- 同步完成后,Webhook 会发送通知
- 后端使用 API Key 获取数据
- Pluggy 每天自动同步;Webhook 会触发数据刷新
完整汇编文档
如需查看包含所有展开规则的完整指南,请参阅:AGENTS.md
评论
支持 Markdown