Apprise API

通过用户友好的API在网络中利用Apprise的功能。

• 发送通知到100多种服务。
• 极其轻量级的Apprise网关。
• 随时可用的生产级微服务。

Apprise API设计用于轻松集成到需要简单通知解决方案的现有（和新）生态系统中。

![]([] ![Follow]([]
![]([] ![CodeCov Status]([] ![Docker Pulls]([***]

截图

内置小型配置管理器，可通过浏览器选择性访问，允许创建和保存任意数量的配置。每个配置通过您指定的唯一{KEY}区分：
!GUI截图 - 使用密钥

以下截图展示如何将Apprise URL分配给{KEY}。您可以定义TEXT或YAML格式的Apprise配置：
!GUI截图 - 配置

保存配置后，可使用通知选项卡向配置中定义的一个或多个服务发送消息。使用标签all可通知所有服务，无论其分配的标签如何。 !GUI截图 - 通知

GUI本质上只是提供了一个用户友好的界面，开发人员也可以直接与相同的API交互。

安装

以下选项可让您通过浏览器访问API：http://localhost:8000/。

使用dockerhub可执行以下命令：

bash
# 获取容器
docker pull caronc/apprise:latest

# 启动容器：
# /config用于持久化存储，如不使用可不必挂载
docker run --name apprise \
   -p 8000:8000 \
   -v /var/lib/apprise/config:/config \
   -d caronc/apprise:latest

已提供docker-compose.yml文件，可立即搭建生产级模拟环境：

bash
# Docker Compose
docker-compose up

配置目录权限

底层Nginx服务以用户（和组）www-data（通常ID为33）读写配置文件。为避免出现“保存配置时出错”，建议将本地/var/lib/apprise/config权限设置如下：

bash
# 创建用户/组（如不存在），ID为33
id 33 &>/dev/null || sudo useradd \
   --system --no-create-home --shell /bin/false \
    -u 33 -g 33 www-data

# 安全设置目录权限，仅允许www-data组访问：
sudo chmod 770 -R /var/lib/apprise/config
sudo chown 33:33 -R /var/lib/apprise/config

# 可选：将自己添加到组以查看内容
sudo usermod -a -G 33 $(whoami)

# 可能需要登出并重新登录使上述设置生效，或临时执行：
sudo su - $(whoami)

另一种简单（但不建议用于生产环境）的方法是设置目录完全读写权限：

bash
# 授予本地配置目录完全权限
chmod 777 /var/lib/apprise/config

Dockerfile详情

支持的架构：amd64、arm/v7和arm64。可用标签：

• latest：指向最新稳定版本。
• edge：指向master分支的最新推送版本。

Apprise URLs

📣 要触发通知，需先定义一个或多个Apprise URL以支持所需服务。Apprise目前支持100多种通知服务，并持续扩展。访问[***]

API详情

无状态解决方案

部分用户可能需要无需持久存储的辅助解决方案。以下API端点可直接发送通知到Apprise支持的服务，无需存储需求：

以下是使用/notify/发送无状态通知的示例：

bash
# 直接发送通知
curl -X POST -d 'urls=mailto://user:***&body=测试消息' \
    http://localhost:8000/notify

# 发送带附件的通知
curl -X POST \
    -F 'urls=mailto://user:***' \
    -F 'body=测试消息' \
    -F attach=@Screenshot-1.png \
    http://localhost:8000/notify

# 发送多个附件，确保attach关键字唯一：
curl -X POST \
    -F 'urls=mailto://user:***' \
    -F 'body=测试消息' \
    -F attach1=@Screenshot-1.png \
    -F attach2=@/my/path/to/Apprise.doc \
    http://localhost:8000/notify

curl -X POST -d 'urls=mailto://user:***&body=测试消息' \
    -F @/path/to/your/attachment \
    http://localhost:8000/notify

# 使用JSON发送通知
curl -X POST -d '{"urls": "mailto://user:***", "body":"测试消息"}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify

持久化存储解决方案

您可预保存Apprise配置和/或URL集，并关联到自定义{KEY}。配置保存后，可通过appriseCLI工具或其他集成检索。内置Web界面提供用户友好的API调用方式，开发者也可使用以下端点：

/json/urls/{KEY}响应示例：

json
{
   "tags": ["devops", "admin", "me"],
   "urls": [
      {
         "url": "slack://TokenA/TokenB/TokenC",
         "tags": ["devops", "admin"]
      },
      {
         "url": "***://WebhookID/WebhookToken",
         "tags": ["devops"]
      },
      {
         "url": "mailto://user:***",
         "tags": ["me"]
      }
   ]
}

可向/json/urls/{KEY}添加参数，如privacy=1隐藏密码和密钥，tag=按标签筛选结果（默认tag=all）。如设置APPRISE_CONFIG_LOCK，privacy=1始终生效，防止凭证泄露。

以下是使用curl向abc123发送通知的示例：

bash
# 向{key}为'abc123'的配置发送通知
curl -X POST -d "body=测试消息" \
    http://localhost:8000/notify/abc123

# 使用JSON发送
curl -X POST -d '{"body":"测试消息"}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify/abc123

# 发送附件：
curl -X POST \
    -F 'urls=mailto://user:***' \
    -F 'body=测试消息' \
    -F attach1=@Screenshot-1.png \
    -F attach2=@/my/path/to/Apprise.doc \
    http://localhost:8000/notify/abc123

🏷️ 可通过标签筛选通知。以下示例向abc123中标签为devops的服务发送通知：

bash
# 向标签为'devops'的服务发送通知
curl -X POST -d 'tag=devops&body=测试消息' \
    http://localhost:8000/notify/abc123

# 使用JSON发送
curl -X POST -d '{"tag":"devops", "body":"测试消息"}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify/abc123

标签使用

标签是Apprise的核心功能之一，可将多个通知分组，为同一URL分配多个标签，并通过标签表达式触发。

bash
# "与"示例
# 向标签为'devops'和'after-hours'的服务发送通知
# 空格表示"与"，也可用"+"代替
curl -X POST -d '{"tag":"devops after-hours", "body":"仓库 outage"}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify/abc123


# "或"示例
# 向标签为'dev'或'qa'的服务发送通知
# 逗号表示"或"，逗号前后空格忽略
curl -X POST -d '{"tag":"dev, qa", "body":"bug #000123 重现 :("}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify/def456


# "与"和"或"组合示例
# 向标签为'leaders与teamA'或'leaders与teamB'的服务发送通知
curl -X POST -d '{"tag":"leaders teamA, leaders teamB", "body":"立即开会"}' \
    -H "Content-Type: application/json" \
    http://localhost:8000/notify/projectX

API注意事项

• {KEY}长度为1-128字符，仅允许字母、数字、下划线（_）和连字符（-）。
• 指定Content-Type: application/json使用JSON格式，默认application/x-www-form-urlencoded。
• API无需认证或SSL加密，设计为轻量级快速微服务。
• 如使用可选持久存储（挂载/config），无额外依赖（如数据库）。

环境变量

环境变量可覆盖默认设置：

Apprise集成

首先安装Apprise：

bash
# 安装apprise到环境
pip install apprise

Apprise CLI拉取示例

从API拉取配置的场景