ClickFunnels技能使用说明
2026-03-29
新闻来源:网淘吧
围观:18
电脑广告
手机广告
ClickFunnels
通过托管的OAuth认证访问ClickFunnels 2.0 API。管理联系人、产品、订单、课程、表单、网络钩子等。
快速开始
# List teams
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/clickfunnels/api/v2/teams')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('User-Agent', 'Maton/1.0')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
基础URL
https://gateway.maton.ai/clickfunnels/{native-api-path}
将{native-api-path}替换为实际的ClickFunnels API端点路径。网关将请求代理到{subdomain}.myclickfunnels.com并自动注入您的OAuth令牌。
认证
所有请求都需要在Authorization标头中包含Maton API密钥,以及一个User-Agent标头:
Authorization: Bearer $MATON_API_KEY
User-Agent: Maton/1.0
环境变量:将您的API密钥设置为MATON_API_KEY:
export MATON_API_KEY="YOUR_API_KEY"
获取您的API密钥
连接管理
在以下网址管理您的ClickFunnels OAuth连接https://ctrl.maton.ai。
列出连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections?app=clickfunnels&status=ACTIVE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
创建连接
python <<'EOF'
import urllib.request, os, json
data = json.dumps({'app': 'clickfunnels'}).encode()
req = urllib.request.Request('https://ctrl.maton.ai/connections', data=data, method='POST')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('Content-Type', 'application/json')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
获取连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
响应:
{
"connection": {
"connection_id": "21fd90f9-5935-43cd-b6c8-bde9d915ca80",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=...",
"app": "clickfunnels",
"metadata": {}
}
}
在浏览器中打开返回的网址以完成OAuth授权。
删除连接
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections/{connection_id}', method='DELETE')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
指定连接
如果您有多个ClickFunnels连接,请使用Maton-Connection标头指定要使用的连接:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://gateway.maton.ai/clickfunnels/api/v2/teams')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
req.add_header('User-Agent', 'Maton/1.0')
req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
如果省略,网关将使用默认(最早创建的)活动连接。
API参考
团队
列出团队
GET /clickfunnels/api/v2/teams
响应:
[
{
"id": 412840,
"public_id": "vPNqAp",
"name": "My Team",
"time_zone": "Pacific Time (US & Canada)",
"locale": "en",
"created_at": "2026-02-07T09:28:29.709Z",
"updated_at": "2026-02-07T11:14:32.118Z"
}
]
获取团队
GET /clickfunnels/api/v2/teams/{team_id}
工作空间
列出工作空间
GET /clickfunnels/api/v2/teams/{team_id}/workspaces
响应:
[
{
"id": 435231,
"public_id": "JZqWGb",
"team_id": 412840,
"name": "My Workspace",
"subdomain": "myworkspace",
"created_at": "2026-02-07T09:28:31.268Z",
"updated_at": "2026-02-07T09:28:34.498Z"
}
]
获取工作空间
GET /clickfunnels/api/v2/workspaces/{workspace_id}
联系人
列出联系人
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts
带筛选条件:
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts?filter[email_address]=user@example.com
响应:
[
{
"id": 1087091674,
"public_id": "PWzmxEx",
"workspace_id": 435231,
"email_address": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": null,
"time_zone": null,
"uuid": "eb7a970c-727d-4c82-9209-bd8f7457a801",
"tags": [],
"custom_attributes": {},
"created_at": "2026-02-07T09:28:52.713Z",
"updated_at": "2026-02-07T09:28:52.777Z"
}
]
获取联系人
GET /clickfunnels/api/v2/contacts/{contact_id}
创建联系人
POST /clickfunnels/api/v2/workspaces/{workspace_id}/contacts
Content-Type: application/json
{
"contact": {
"email_address": "newuser@example.com",
"first_name": "Jane",
"last_name": "Smith",
"phone_number": "+1234567890"
}
}
更新联系人
PUT /clickfunnels/api/v2/contacts/{contact_id}
Content-Type: application/json
{
"contact": {
"first_name": "Updated Name",
"phone_number": "+1987654321"
}
}
删除联系人
DELETE /clickfunnels/api/v2/contacts/{contact_id}
成功时返回HTTP 204状态码。
更新或插入联系人
根据匹配的邮箱创建或更新联系人:
POST /clickfunnels/api/v2/workspaces/{workspace_id}/contacts/upsert
Content-Type: application/json
{
"contact": {
"email_address": "user@example.com",
"first_name": "Updated"
}
}
GDPR 数据清除联系人
DELETE /clickfunnels/api/v2/workspaces/{workspace_id}/contacts/{contact_id}/gdpr_destroy
产品
列出产品
GET /clickfunnels/api/v2/workspaces/{workspace_id}/products
响应:
[
{
"id": 962732,
"public_id": "jAvBEA",
"workspace_id": 435231,
"name": "My Product",
"current_path": "/my-product",
"archived": false,
"visible_in_store": true,
"visible_in_customer_center": true,
"default_variant_id": 5361073,
"variant_ids": [5361073],
"price_ids": [],
"tag_ids": [],
"created_at": "2026-02-09T07:23:02.158Z",
"updated_at": "2026-02-09T07:23:02.163Z"
}
]
获取产品
GET /clickfunnels/api/v2/products/{product_id}
创建产品
POST /clickfunnels/api/v2/workspaces/{workspace_id}/products
Content-Type: application/json
{
"product": {
"name": "New Product",
"visible_in_store": true,
"visible_in_customer_center": true
}
}
更新产品
PUT /clickfunnels/api/v2/products/{product_id}
Content-Type: application/json
{
"product": {
"name": "Updated Product Name"
}
}
归档产品
POST /clickfunnels/api/v2/products/{product_id}/archive
取消归档产品
POST /clickfunnels/api/v2/products/{product_id}/unarchive
订单
列出订单
GET /clickfunnels/api/v2/workspaces/{workspace_id}/orders
获取订单
GET /clickfunnels/api/v2/orders/{order_id}
更新订单
PUT /clickfunnels/api/v2/orders/{order_id}
Content-Type: application/json
{
"order": {
"notes": "Updated order notes"
}
}
履约记录
列出履约记录
GET /clickfunnels/api/v2/workspaces/{workspace_id}/fulfillments
获取履约记录
GET /clickfunnels/api/v2/fulfillments/{fulfillment_id}
创建履约记录
POST /clickfunnels/api/v2/workspaces/{workspace_id}/fulfillments
Content-Type: application/json
{
"fulfillment": {
"contact_id": 1087091674,
"location_id": 12345,
"tracking_url": "https://tracking.example.com/123",
"shipping_provider": "ups",
"tracking_code": "1Z999AA10123456784",
"notify_customer": true
}
}
取消履约记录
POST /clickfunnels/api/v2/fulfillments/{fulfillment_id}/cancel
课程
列出课程
GET /clickfunnels/api/v2/workspaces/{workspace_id}/courses
获取课程
GET /clickfunnels/api/v2/courses/{course_id}
注册记录
列出注册记录
GET /clickfunnels/api/v2/courses/{course_id}/enrollments
创建注册记录
POST /clickfunnels/api/v2/courses/{course_id}/enrollments
Content-Type: application/json
{
"courses_enrollment": {
"contact_id": 1087091674
}
}
更新注册记录
PUT /clickfunnels/api/v2/courses/{course_id}/enrollments/{enrollment_id}
Content-Type: application/json
{
"courses_enrollment": {
"suspended": true,
"suspension_reason": "Payment failed"
}
}
表单
列出表单
GET /clickfunnels/api/v2/workspaces/{workspace_id}/forms
响应:
[
{
"id": 442896,
"public_id": "NdOxzL",
"workspace_id": 435231,
"name": "Contact Form",
"created_at": "2026-02-07T09:28:33.316Z",
"updated_at": "2026-02-07T09:28:33.316Z"
}
]
获取表单
GET /clickfunnels/api/v2/forms/{form_id}
列出表单提交
GET /clickfunnels/api/v2/forms/{form_id}/submissions
图片
列出图片
GET /clickfunnels/api/v2/workspaces/{workspace_id}/images
响应:
[
{
"id": 20670308,
"public_id": "mvvWWM",
"url": "https://statics.myclickfunnels.com/workspace/JZqWGb/image/20670308/file/image.png",
"workspace_id": 435231,
"alt_text": null,
"name": null,
"created_at": "2026-02-07T09:28:40.102Z",
"updated_at": "2026-02-07T09:29:01.697Z"
}
]
创建图片(通过URL)
POST /clickfunnels/api/v2/workspaces/{workspace_id}/images
Content-Type: application/json
{
"image": {
"upload_source_url": "https://example.com/image.png"
}
}
Webhooks
列出Webhook端点
GET /clickfunnels/api/v2/workspaces/{workspace_id}/webhooks/outgoing/endpoints
响应:
[
{
"id": 96677,
"public_id": "vBZlEl",
"workspace_id": 435231,
"url": "https://example.com/webhook",
"name": "My Webhook",
"event_type_ids": ["contact.created"],
"api_version": 2,
"webhook_secret": "e779d4b2faa7d986...",
"created_at": "2026-02-09T07:23:22.295Z",
"updated_at": "2026-02-09T07:23:22.295Z"
}
]
创建 Webhook 端点
POST /clickfunnels/api/v2/workspaces/{workspace_id}/webhooks/outgoing/endpoints
Content-Type: application/json
{
"webhooks_outgoing_endpoint": {
"url": "https://example.com/webhook",
"name": "New Webhook",
"event_type_ids": ["contact.created", "order.created"]
}
}
获取 Webhook 端点
GET /clickfunnels/api/v2/webhooks/outgoing/endpoints/{endpoint_id}
更新 Webhook 端点
PUT /clickfunnels/api/v2/webhooks/outgoing/endpoints/{endpoint_id}
Content-Type: application/json
{
"webhooks_outgoing_endpoint": {
"name": "Updated Webhook",
"event_type_ids": ["contact.created", "contact.updated"]
}
}
删除 Webhook 端点
DELETE /clickfunnels/api/v2/webhooks/outgoing/endpoints/{endpoint_id}
成功时返回 HTTP 204。
分页
ClickFunnels 使用基于游标的分页。每个列表端点最多返回 20 个项目。
使用after参数,并传入最后一个项目的 ID 以获取下一页:
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts?after=1087091674
响应头:
Pagination-Next:最后一个项目的 ID(用于获取下一页)Link:下一页的完整 URL
分页流程示例:
# First page
GET /clickfunnels/api/v2/workspaces/{workspace_id}/images
# Response header: Pagination-Next: 20670327
# Next page
GET /clickfunnels/api/v2/workspaces/{workspace_id}/images?after=20670327
筛选
使用filter查询参数来筛选列表结果:
# Filter by email
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts?filter[email_address]=user@example.com
# Filter by multiple emails (OR)
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts?filter[email_address]=user1@example.com,user2@example.com
# Multiple filters (AND)
GET /clickfunnels/api/v2/workspaces/{workspace_id}/contacts?filter[email_address]=user@example.com&filter[id]=1087091674
代码示例
JavaScript
const response = await fetch(
'https://gateway.maton.ai/clickfunnels/api/v2/teams',
{
headers: {
'Authorization': `Bearer ${process.env.MATON_API_KEY}`,
'User-Agent': 'Maton/1.0'
}
}
);
const teams = await response.json();
Python
import os
import requests
response = requests.get(
'https://gateway.maton.ai/clickfunnels/api/v2/teams',
headers={
'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}',
'User-Agent': 'Maton/1.0'
}
)
teams = response.json()
创建联系人示例
import os
import requests
response = requests.post(
'https://gateway.maton.ai/clickfunnels/api/v2/workspaces/435231/contacts',
headers={
'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}',
'Content-Type': 'application/json',
'User-Agent': 'Maton/1.0'
},
json={
'contact': {
'email_address': 'newuser@example.com',
'first_name': 'Jane',
'last_name': 'Smith'
}
}
)
contact = response.json()
备注
- 团队ID、工作区ID和资源ID均为整数
- 每个资源还拥有一个
公共ID(字符串类型),用于公开访问的URL - 列表接口默认每页最多返回20项
- 使用
after参数进行分页 - 删除操作返回HTTP 204状态码及空响应体
- 请求体使用嵌套资源键(例如:
{"contact": {...}}) - 图像最大尺寸:10MB,最大分辨率:10,000 x 10,000像素
- 支持的图像格式:JPEG、PNG、WebP、GIF、SVG
- 重要提示:使用curl命令时,若URL包含方括号,请使用
curl -g以禁用通配符解析 - 重要提示:将curl输出通过管道传递给
jq时或其他命令中的环境变量,例如$MATON_API_KEY在某些Shell环境中可能无法正确展开
错误处理
| 状态码 | 含义 |
|---|---|
| 400 | 缺少ClickFunnels连接 |
| 401 | Maton API密钥无效或缺失 |
| 404 | 资源未找到 |
| 422 | 验证错误(请检查响应体) |
| 429 | 请求频率受限 |
| 4xx/5xx | 来自ClickFunnels API的透传错误 |
故障排除:API密钥问题
- 请检查
MATON_API_KEY环境变量是否已设置:
echo $MATON_API_KEY
- 通过列出连接来验证API密钥是否有效:
python <<'EOF'
import urllib.request, os, json
req = urllib.request.Request('https://ctrl.maton.ai/connections')
req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}')
print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2))
EOF
故障排除:无效的应用名称
- 请确保您的URL路径以
clickfunnels开头。例如:
- 正确示例:
https://gateway.maton.ai/clickfunnels/api/v2/teams - 错误示例:
https://gateway.maton.ai/api/v2/teams
资源
文章底部电脑广告
手机广告位-内容正文底部
上一篇:SoulCraft技能使用说明
下一篇:Task Tracker技能使用说明


微信扫一扫,打赏作者吧~