介绍
# Typeform
通过托管 OAuth 身份验证访问 Typeform API。创建和管理表单、检索响应并获取洞察。
## 快速开始
```bash # List forms python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/typeform/forms?page_size=10') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
## 基础 URL
``` https://gateway.maton.ai/typeform/{native-api-path} ```
将 `{native-api-path}` 替换为实际的 Typeform API 端点路径。网关将请求代理到 `api.typeform.com` 并自动注入您的 OAuth 令牌。
## 身份验证
所有请求都需要在 Authorization 标头中提供 Maton API 密钥：
``` Authorization: Bearer $MATON_API_KEY ```
**环境变量：** 将您的 API 密钥设置为 `MATON_API_KEY`：
```bash export MATON_API_KEY="YOUR_API_KEY" ```
### 获取 API 密钥
1. 在 [maton.ai](https://maton.ai) 登录或创建账户 2. 前往 [maton.ai/settings](https://maton.ai/settings) 3. 复制您的 API 密钥
## 连接管理
在 `https://ctrl.maton.ai` 管理您的 Typeform OAuth 连接。
### 列出连接
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://ctrl.maton.ai/connections?app=typeform&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 ```
### 创建连接
```bash python <<'EOF' import urllib.request, os, json data = json.dumps({'app': 'typeform'}).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 ```
### 获取连接
```bash 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 ```
**响应：** ```json { "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": "typeform", "metadata": {} } } ```
在浏览器中打开返回的 `url` 以完成 OAuth 授权。
### 删除连接
```bash 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 ```
### 指定连接
如果您有多个 Typeform 连接，请使用 `Maton-Connection` 标头指定要使用的连接：
```bash python <<'EOF' import urllib.request, os, json req = urllib.request.Request('https://gateway.maton.ai/typeform/forms?page_size=10') req.add_header('Authorization', f'Bearer {os.environ["MATON_API_KEY"]}') req.add_header('Maton-Connection', '21fd90f9-5935-43cd-b6c8-bde9d915ca80') print(json.dumps(json.load(urllib.request.urlopen(req)), indent=2)) EOF ```
如果省略，网关将使用默认（最早）的活动连接。
## API 参考
### 用户
```bash GET /typeform/me ```
### 表单
#### 列出表单
```bash GET /typeform/forms?page_size=10 ```
#### 获取表单
```bash GET /typeform/forms/{formId} ```
#### 创建表单
```bash POST /typeform/forms Content-Type: application/json
{ "title": "Customer Survey", "fields": [ {"type": "short_text", "title": "What is your name?"}, {"type": "email", "title": "What is your email?"} ] } ```
#### 更新表单
```bash PUT /typeform/forms/{formId} Content-Type: application/json
{ "title": "Updated Survey Title", "fields": [...] } ```
#### 删除表单
```bash DELETE /typeform/forms/{formId} ```
### 响应
#### 列出响应
```bash GET /typeform/forms/{formId}/responses?page_size=25 ```
使用筛选器：
```bash GET /typeform/forms/{formId}/responses?since=2024-01-01T00:00:00Z&until=2024-12-31T23:59:59Z&completed=true ```
### 洞察
```bash GET /typeform/insights/{formId}/summary ```
### 工作区
```bash GET /typeform/workspaces GET /typeform/workspaces/{workspaceId} ```
## 字段类型
- `short_text` - 单行文本 - `long_text` - 多行文本 - `email` - 电子邮件地址 - `number` - 数字输入 - `rating` - 星级评分 - `opinion_scale` - 0-10 量表 - `multiple_choice` - 单选或多选 - `yes_no` - 布尔值 - `date` - 日期选择器 - `dropdown` - 下拉选择
## 代码示例
### JavaScript
```javascript const response = await fetch( 'https://gateway.maton.ai/typeform/forms?page_size=10', { headers: { 'Authorization': `Bearer ${process.env.MATON_API_KEY}` } } ); ```
### Python
```python import os import requests
response = requests.get( 'https://gateway.maton.ai/typeform/forms', headers={'Authorization': f'Bearer {os.environ["MATON_API_KEY"]}'}, params={'page_size': 10} ) ```
## 注意事项
- 表单 ID 是字母数字字符串 - 响应分页使用 `before` 令牌 - 时间戳采用 ISO 8601 格式 - DELETE 操作返回 HTTP 204 - 重要：使用 curl 命令时，如果 URL 包含括号（`fields[]`、`sort[]`、`records[]`），请使用 `curl -g` 以禁用 glob 解析 - 重要：将 curl 输出通过管道传递给 `jq` 或其他命令时，`$MATON_API_KEY` 等环境变量在某些 Shell 环境中可能无法正确展开。在进行管道传输时，您可能会遇到“Invalid API key”错误。
## 错误处理
| 状态 | 含义 | |--------|---------| | 400 | 缺少 Typeform 连接 | | 401 | Maton API 密钥无效或缺失 | | 429 | 速率受限（每账户每秒 10 次请求）| | 4xx/5xx | 来自 Typeform API 的透传错误 |
### 故障排除：API 密钥问题
1. 检查是否已设置 `MATON_API_KEY` 环境变量：
```bash echo $MATON_API_KEY ```
2. 通过列出连接来验证 API 密钥是否有效：
```bash 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 ```
### 故障排除：无效的应用名称
1. 确保您的 URL 路径以 `typeform` 开头。例如：
- 正确：`https://gateway.maton.ai/typeform/forms` - 错误：`https://gateway.maton.ai/forms`
## 资源
- [Typeform API 概述](https://www.typeform.com/developers/get-started) - [表单](https://www.typeform.com/developers/create/reference/retrieve-forms) - [响应](https://www.typeform.com/developers/responses/reference/retrieve-responses) - [工作区](https://www.typeform.com/developers/create/reference/retrieve-workspaces) - [Maton 社区](https://discord.com/invite/dBfFAcefs2) - [Maton 支持](mailto:[email protected])