完整 Salesflare API 操作技能,用于读取、搜索、创建和更新 CRM 数据(账户、联系人、机会、任务、管道、用户、标签等)
Salesflare API.
功能概述
Salesflare API.是一项面向实际任务的技能,主要用于Overview. 使用此技能与 Salesflare REST API 安全一致地工作. default 方法: 发现端点形状和需要的字段. 先读/检查请求.。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
核心要点
- 使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。
- 该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。
- 从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。
使用与执行
实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。
结果检查与注意事项
执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
Salesflare API
概述
使用本技能安全、一致地调用 Salesflare REST API。
默认操作流程:
- 发现端点结构及必需字段
- 首先执行读取/校验请求
- 在修改数据前向用户请求确认
- 执行变更操作,并返回包含 ID 的精简结果
快速开始
在发起请求前,请先设置 API 密钥:
export SALESFLARE_API_KEY='your_key_here'
- 基础 URL:
https://api.salesflare.com(生产环境,默认) - 认证请求头:
Authorization: Bearer - 可选本地覆盖:如需本地测试,可设置
SALESFLARE_BASE_URL为预发布(staging)环境 URL。 - 本地密钥请仅存于被 .gitignore 忽略的
.env.local文件或进程环境变量中。切勿将 API 密钥或 smoke-test 输出与本技能一同发布。
核心脚本
scripts/sf.py— 统一 CLI 封装器(子命令包括:discover、request、get、post、put、patch、delete、smoketest)scripts/sf_discover.py— 基于 OpenAPI 发现/列出端点及其支持的 HTTP 方法scripts/sf_request.py— 执行 GET/POST/PATCH/PUT/DELETE 请求,内置重试机制;支持查询参数、JSON 请求体、自动分页scripts/sf_smoketest.py— 对 OpenAPI 定义的操作进行 smoke-test。默认为只读模式;生命周期写入测试需显式指定--allow-write,而清理删除操作则需同时指定--allow-write --allow-delete。
工作流
1) 发现端点及其结构
python scripts/sf.py discover --contains opportunities python scripts/sf.py discover --tag Accounts
2) 通过读取请求验证
python scripts/sf.py get --path /accounts --query limit=5 --query search=acme
3) 写入前确认操作意图
执行 POST、PUT、PATCH 或 DELETE 操作前,必须始终获得用户明确确认。
对于 DELETE 操作,无论上下文如何,均须要求显式确认——不得基于先前对话推断用户同意。
4) 执行写入并返回报告
返回内容应包括:
- 已执行的操作类型
- 目标实体 ID(s)
- 发生变更的关键字段
- API 响应摘要
5) 安全地执行 smoke-test
默认 smoke test 为只读模式:
python scripts/sf.py smoketest
如需启用生命周期写入路径测试,请显式开启。该模式将:先创建受控测试记录;再执行 GET 列表查询及按 ID 查询;仅更新由本次 smoke-test 创建的记录;最后仅删除本次创建的记录:
python scripts/sf.py smoketest --allow-write --allow-delete
生命周期写入覆盖范围有意限定为 smoke test 可完全拥有并清理的数据类型:accounts、contacts、opportunities、tasks、meetings、internal notes/messages 和 tags。此外,还测试对测试 account 的 account-contact/account-user 关系更新,以及对测试 message 的 feedback 更新。其余写入端点若无法在该生命周期内被安全表示,则默认标记为跳过。
如需执行写入覆盖但不执行清理(即保留所创建的记录),请显式运行:
python scripts/sf.py smoketest --allow-write
变更操作安全规则
- POST/PUT/PATCH:执行前必须获得用户显式确认;严禁推断用户同意。
- DELETE:执行前必须获得用户显式确认;严禁推断用户同意。
- Smoke-test 默认为只读。如需带清理的生命周期写入测试,请使用
--allow-write --allow-delete。其中PUT和DELETE仅作用于本次 smoke-test 运行所创建的记录。 - 若生命周期写入测试意外中断,请在重新运行前,在 Salesflare 中搜索名称为
OpenClaw Smoke的记录,或标签以openclaw-smoke-开头的记录。 - 未经显式确认,禁止执行批量变更操作。
- 优先采用单条记录更新,再考虑批量更新。
- 所有写入操作的输出中必须包含 ID,确保可追溯性。
- 遇到 HTTP 429(Too Many Requests)时,依赖脚本内置的重试与退避机制;若重试耗尽,请立即停止并清晰报告错误。
输出规范
- 默认输出:简洁摘要 + 关键 ID/字段
- 仅当用户明确要求完整载荷时,才提供原始 JSON
- 对于大型结果集,返回前 N 条,并在可用时注明总数
过滤方式
- 直接支持:通过重复使用
--query key=value传入简单查询参数 - 高级 Salesflare 查询构建器过滤(
q对象/规则):如需使用,请以原始序列化格式作为查询载荷传入 - 本技能不提供用于组合复杂
q结构的高级 DSL
常用端点
/accounts /contacts /opportunities
/accounts/{account_id}/feed
/tasks /pipelines /users /me
/tags /workflows
具体命令示例与写入模式,请参阅 references/endpoints.md。
已知端点注意事项
GET /accounts/{account_id}/feed— 当工作区启用了账户动态信息流(feed/timeline)功能时,该端点返回对应账户的 feed。若不可用,请联系support@salesflare.com,并请求 Salesflare 启用账户 feed API 访问权限。GET /persons— 空参数调用可能返回 500 错误。建议改用?search=...或?id=...参数。GET /tags/{tag_id}— 即使传入有效 ID,也可能返回 500 错误;请改用GET /tags和GET /tags/{tag_id}/usage。GET /persons过滤字段 —GET /filterfields/person将返回 400 错误;请改用contact。- 完整端点注意事项列表,请参阅
references/endpoints.md。
资源
scripts/
sf.py— 统一 CLI 封装器sf_discover.py— 基于 OpenAPI 的端点发现工具sf_request.py— 认证 API 调用辅助模块sf_smoketest.py— 全量操作 smoke-test 执行器
references/
endpoints.md— 实用请求示例、写入模式及各端点专属注意事项
热门AI工具
相关专题
本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。
0
2026.11.06
围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。
0
2026.11.06
详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。
0
2026.11.06
DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。
0
2026.11.05
DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。
0
2026.11.05
本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。
0
2026.11.04
本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。
0
2026.11.04
热门下载
相关下载
精品课程
共6课时 | 12.1万人学习
共79课时 | 161.7万人学习
共6课时 | 54.7万人学习
最新文章