mirror of
https://github.com/dreamhunter2333/cloudflare_temp_email.git
synced 2026-09-04 23:17:34 +08:00
docs: clarify Address JWT vs User JWT and reorganize API menu (#914)
- Add warning notes in new-address-api and mail-api docs - Explain the difference between Address JWT and User JWT - Create dedicated 'API Endpoints' section in sidebar - Update both zh and en documentation Refs #910
This commit is contained in:
@@ -131,6 +131,14 @@ print(response.json())
|
||||
|
||||
## user 邮件 API
|
||||
|
||||
::: warning 注意:用户 JWT vs 地址 JWT
|
||||
此接口使用**用户 JWT**(通过 `/user_api/login` 或 `/user_api/register` 获得),使用 `x-user-token` header。
|
||||
|
||||
**请勿与地址 JWT 混淆**:
|
||||
- 地址 JWT 使用 `Authorization: Bearer <jwt>` 访问 `/api/*` 接口
|
||||
- 用户 JWT 使用 `x-user-token: <jwt>` 访问 `/user_api/*` 接口
|
||||
:::
|
||||
|
||||
支持 `address` 过滤
|
||||
|
||||
```python
|
||||
|
||||
@@ -1,5 +1,19 @@
|
||||
# 新建邮箱地址 API
|
||||
|
||||
::: warning 注意:地址 JWT vs 用户 JWT
|
||||
本页面介绍的是**地址 JWT**,与**用户 JWT** 是两种不同的认证方式:
|
||||
|
||||
- **地址 JWT**:通过 `/api/new_address` 或 `/admin/new_address` 创建邮箱时返回
|
||||
- 使用 `Authorization: Bearer <jwt>` header
|
||||
- 用于访问 `/api/*` 接口(查看邮件、删除邮件等)
|
||||
|
||||
- **用户 JWT**:通过 `/user_api/login` 或 `/user_api/register` 获得
|
||||
- 使用 `x-user-token: <jwt>` header
|
||||
- 用于访问 `/user_api/*` 接口(用户账户管理)
|
||||
|
||||
**请勿混淆两种 JWT 的使用方式!**
|
||||
:::
|
||||
|
||||
## 通过 admin API 新建邮箱地址
|
||||
|
||||
这是一个 `python` 的例子,使用 `requests` 库发送邮件。
|
||||
|
||||
Reference in New Issue
Block a user