Bark 推送服务技术文档

Bark 推送服务技术文档

Bark Bark is an iOS App which allows you to push custom notifications to your iPhone 项目地址: https://gitcode.com/gh_mirrors/bar/Bark

Bark是一款高效的通知推送工具，允许用户自定义推送至iOS设备。下面将详细介绍如何安装配置Bark及其API的使用方法。

安装指南

Bark App安装

1. iOS设备: 直接通过App Store搜索"Bark"并下载官方应用。

配套工具安装

• 对于Chrome浏览器用户，推荐安装Bark-Chrome-Extension，便于网页内容快速推送。
• 开发者可选择安装跨平台命令行工具bark-cli以方便集成到自动化流程中。

项目使用说明

Bark的核心在于通过HTTP请求发送定制化的通知到您的iOS设备。您需要获取到设备的key，这是您推送的基础。

1. 启动Bark App，找到个人设置中的设备Key。
2. 使用该Key构建请求URL。

项目API使用文档

Bark API极其灵活，支持多种参数以定制推送通知。

基础请求格式

• GET请求示例:

  https://api.day.app/yourkey/消息内容
  

• POST请求示例:

  {
    "key": "yourkey",
    "title": "标题",
    "body": "正文\n第二行"
  }
  

参数详解

• :key: 设备唯一标识。
• /title/:body: 自定义标题和内容。
• /category/:title/:body: category暂时不可用，忽略。
• automaticallyCopy=1: 推送到达时自动复制内容到剪贴板。
• copy=指定内容: 强制复制特定内容而非整个消息。
• url=https://example.com: 点击通知时跳转的链接。
• isArchive=1: 保存推送至历史记录。
• group=groupName: 推送分组。
• icon=http://image-url: iOS 15+可用，自定义推送图标。
• level=timeSensitive: 通知类型，影响显示方式，如timeSensitive适合重要但不需要即时响应的信息。

示例场景

自动复制验证码:

https://api.day.app/yourkey/验证码是123456?automaticallyCopy=1&copy=123456

带跳转链接的通知:

https://api.day.app/yourkey/访问我的网站?url=https://www.example.com/

后端部署与扩展

• 自建后端: 使用bark-server，支持Docker部署，让您控制推送逻辑和服务。
• 集成到GitHub Actions: 利用harryzcy/action-bark，实现在代码提交等事件时自动推送通知。

相关生态

• Windows客户端: BarkHelper便于Windows用户操作。
• Wox插件: Bark for Wox，结合快捷启动工具，提升效率。
• JavaScript SDK: bark-jssdk简化Web端集成。

结语

Bark以其简洁高效的特性，成为了跨设备通知推送的强大解决方案。无论是开发者还是日常用户，都可以轻松利用Bark的强大功能，实现个性化通知推送需求。遵循上述文档，开始享受便捷的通知体验吧！

---

本文档旨在提供清晰的指导，帮助您充分利用Bark的所有功能。若在使用过程中遇到问题，可通过Bark反馈群寻求社区帮助。

Bark Bark is an iOS App which allows you to push custom notifications to your iPhone 项目地址: https://gitcode.com/gh_mirrors/bar/Bark