API 概述
WhenToMeet API 提供程序化访问以创建和管理日程安排事件。本页面涵盖前提条件和要点—有关完整的端点文档、请求/响应架构和交互式测试,请访问 API 参考。
快速开始
1. 获取 API 访问权限
API 需要 Plus 或 Plus Lifetime 订阅。
2. 创建 API 密钥
- 转到设置 → API 密钥
- 点击"创建 API 密钥"
- 给它一个描述性名称(例如"生产服务器")
- 立即复制密钥 - 只显示一次
- 安全存储(环境变量、密钥管理器等)
3. 探索 API
访问 API 参考 以:
- 浏览所有可用端点
- 查看请求/响应架构
- 交互式测试 API 调用
- 查看代码示例
认证
所有请求都需要 Bearer 令牌:
Authorization: Bearer sk_your_api_key_here
API 密钥安全
✅ 应该做:
- 将密钥存储在环境变量或密钥管理器中
- 为 dev/staging/production 使用不同的密钥
- 定期轮换密钥
- 立即撤销泄露的密钥
❌ 不应该做:
- 将密钥提交到版本控制
- 通过电子邮件或聊天共享密钥
- 在客户端代码中嵌入密钥
- 在多个应用程序中重用密钥
速率限制
| 等级 | 限制 | 时间窗口 |
|---|---|---|
| 免费 | 32 个请求 | 终身总计 |
| Plus | 1,000 个请求 | 每小时(滚动) |
| Plus Lifetime | 1,000 个请求 | 每小时(滚动) |
速率限制标头
响应包括:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1736956800
当受速率限制时(429 响应):
- 实施指数退避
- 检查
X-RateLimit-Reset以获取重置时间 - 监控
X-RateLimit-Remaining以主动限流