Paddy藏宝阁

PaddyAPI使用说明

2024年9月7日

概述

PaddyAPI 是一个 RESTful API，全程基于Docker开发和部署并强制TLS2.0加密传输保证数据安全。旨在为用户提供多种功能。本文档将介绍如何使用该 API 及其主要功能。

基本信息

API 端点

1. POST /paddyapi/UpdateInfo

更新已有用户邮箱信息、订阅状态.

请求示例:

POST https://paddyapi.paddypan.cn/PaddyAPI/UpdateInfo?usernamemd5=123&useremail=123@qq.com&issend=0

如需修改本人收件地址需传入用户唯一号(md5)、邮箱地址(mail)、是否接受邮件(1/0)。

响应示例:

更新成功/更新失败

2. GET /GetHitokoto

获取一条来自 Hitokoto 的句子。

请求示例:

GET https://yy.paddypan.cn/

响应示例:

{
  "id": 4610,
  "uuid": "69b41e5c-3538-4f9e-b6c9-64cd63d21f3b",
  "hitokoto": "我觉得世界无聊，是因为我的世界本身已经足够有趣了。",
  "type": "c",
  "from": "永远的七日之都 璐璐",
  "from_who": null,
  "creator": "Amadeus",
  "creator_uid": 2230,
  "reviewer": 0,
  "commit_from": "web",
  "created_at": "1567584926",
  "length": 25
}

3. POST /paddyapi/AddUser

添加新用户。

请求示例:

POST https://paddyapi.paddypan.cn/PaddyAPI/AddUser?token=123&username=张三&useremail=123@qq.com

其中token必须为管理员身份，才有权限添加用户。

响应:

{
"status": "success",
"message": "User added successfully"
}

4. POST /paddyapi/SendEmail

描述: 发送电子邮件。

请求示例:

POST https://paddyapi.paddypan.cn/PaddyAPI/SendEmail?recievemail=123@qq.com&titlemail=邮件标题&bodymail=邮件正文&token=111111

其中recievemail的值为各位姓名的4种md5复合加密串（在给位邮箱中）则为向对应维护组长发送邮件无需校验token，如recievemail的值为邮箱地址则视为第三方调用需要校验token(联系管理员获取)。

响应示例:

{
"status": "发送成功",
"message": "Email sent successfully."
}

py