用途:为与 Virtuous CRM REST API 交互的代码提供集成参考,适用于构建捐赠者管理相关功能。
基础信息:基础地址为 https://api.virtuoussoftware.com。
认证:支持两种方式。API Key(推荐用于集成):请求头 Authorization: Bearer <api-key>,密钥在 Virtuous UI 中创建。OAuth 令牌(用于基于用户的交互):curl -d "grant_type=password&username=EMAIL&password=PASSWORD" -X POST https://api.virtuoussoftware.com/Token,令牌有效期 15 天,刷新令牌 365 天。
速率限制:每小时 1,500 次请求;响应头包含 X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset。
API 分类:账户/权限(认证令牌、组织、权限)、联系人/个人(捐赠者记录、地址、方式、备注、标签、关系)、捐赠(礼品、指定用途、asks、承诺、定期捐赠、赠品)、活动(活动、沟通、细分)、项目(项目管理、支出、备注、角色)、事件(活动管理、参与者)、资助(资助跟踪与查询)、任务(任务创建与查询)、Webhook(事件订阅)。
关键端点示例:联系人 GET /api/Contact/:contactId、POST /api/Contact/Query、POST /api/Contact/Transaction;礼品 GET /api/Gift/:giftId、POST /api/Gift/Query、POST /api/Gift/Transaction、GET /api/Gift/ByContact/:contactId;定期捐赠 GET /api/RecurringGift/:id、POST /api/RecurringGift/Query、GET /api/RecurringGift/ByContact/:contactId;项目 GET /api/Project/:projectId、POST /api/Project/Query;任务 POST /api/Task、POST /api/Task/Query、GET /api/Task/Types。
最佳实践:礼品与联系人使用 Transaction 端点以避免重复;用 Webhook 代替轮询获取更新;批量获取多条记录时使用 Query 端点;非 200 状态码时检查响应消息。
完整参考:完整端点规范、请求/响应模式与示例见 references/Virtuous.postman_collection.json,建议用 grep 搜索而非读取整个文件,例如按名称 grep '"name":.*Gift'、按方法 grep '"method": "POST"'、按路径 grep '"path":'、按响应示例 grep '"body":'。
限制:该技能与 Virtuous 无隶属、背书或赞助关系,仅引用公开 API 文档用于教育与集成目的,信息可能过时或不完整,最新规范请以官方 Virtuous 文档为准。