更新文档

This commit is contained in:
Fin 2025-01-25 10:05:35 +08:00
parent cc223e0744
commit c6719a680d
4 changed files with 9 additions and 13 deletions

View File

@ -1,6 +1,6 @@
When you need to integrate Bark into your own system or re-implement the backend code, you may need to push certificates. When you need to integrate Bark into your own system or re-implement the backend code, you may need to push certificates.
##### 有效期到: *Permanent* ##### Valid Until: *Permanent*
##### Key ID*LH4T9V5U4R* ##### Key ID: *LH4T9V5U4R*
##### TeamID*5U8LBRXG3A* ##### Team ID: *5U8LBRXG3A*
##### 下载地址:[AuthKey_LH4T9V5U4R_5U8LBRXG3A.p8](https://github.com/Finb/bark-server/releases/download/v1.0.2/AuthKey_LH4T9V5U4R_5U8LBRXG3A.p8) ##### Download Link: [AuthKey_LH4T9V5U4R_5U8LBRXG3A.p8](https://github.com/Finb/bark-server/releases/download/v1.0.2/AuthKey_LH4T9V5U4R_5U8LBRXG3A.p8)

View File

@ -30,7 +30,7 @@ Note: The bark-server uses the /data directory by default to store data. Ensure
## Cloudflare Worker ## Cloudflare Worker
[https://github.com/cwxiaos/bark-worker](https://github.com/cwxiaos/bark-worker) [https://github.com/cwxiaos/bark-worker](https://github.com/cwxiaos/bark-worker)
## 测试 ## Test
``` ```
curl http://0.0.0.0:8080/ping curl http://0.0.0.0:8080/ping
``` ```
@ -69,8 +69,6 @@ services:
## 其他 ## 其他
1. The app sends the <a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622958-application">DeviceToken</a>to the server.<br>The server sends push requests to Apples servers. 1. The app sends the <a href="https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1622958-application">DeviceToken</a>to the server.<br>The server sends push requests to Apples servers.
2. Server code: <a href='https://github.com/Finb/bark-server'>https://github.com/Finb/bark-server</a><br> 2. Server code: <a href='https://github.com/Finb/bark-server'>https://github.com/Finb/bark-server</a><br>
3. App code: <a href="https://github.com/Finb/Bark">https://github.com/Finb/Bark</a> 3. App code: <a href="https://github.com/Finb/Bark">https://github.com/Finb/Bark</a>

View File

@ -19,7 +19,7 @@ Just exit APP when you are on history message page. When you open APP again, it
#### Does push API support POST request? #### Does push API support POST request?
Bark supports GET POST , supports using Json <br> Bark supports GET POST , supports using Json <br>
No matter which request method, parameter names are the same. Refer to [usage tutorial](/tutorial) No matter which request method, parameter names are the same. Refer to [usage tutorial](/en-us/tutorial)
#### Pushing special characters causes push failure. For example: Push content contains link or Push abnormal such as + becomes space #### Pushing special characters causes push failure. For example: Push content contains link or Push abnormal such as + becomes space
This is because of the problem of irregular link. It often happens<br> This is because of the problem of irregular link. It often happens<br>

View File

@ -20,7 +20,7 @@ The URL consists of the push key, parameter title, parameter subtitle, and param
```sh ```sh
curl https://api.day.app/your_key/body?group=groupName&copy=copyText curl https://api.day.app/your_key/body?group=groupName&copy=copyText
``` ```
*When manually appending parameters to the URL, please pay attention to URL encoding issues. *When manually appending parameters to the URL, please pay attention to URL encoding issues.*
##### POST request parameters are placed in the request body, for example: ##### POST request parameters are placed in the request body, for example:
```sh ```sh
@ -70,10 +70,8 @@ List of supported parameters, specific effects can be previewed in the APP.
| autoCopy | Pass "1" to automatically copy the push content on iOS14.5 and below, on iOS14.5 and above, you need to long press or pull down the push to copy | | autoCopy | Pass "1" to automatically copy the push content on iOS14.5 and below, on iOS14.5 and above, you need to long press or pull down the push to copy |
| copy | When copying the push, specify the content to copy, if this parameter is not passed, the entire push content will be copied. | | copy | When copying the push, specify the content to copy, if this parameter is not passed, the entire push content will be copied. |
| sound | Can set different ringtones for the push | | sound | Can set different ringtones for the push |
| icon | Set a custom icon for the push, the set icon will replace the default Bark icon. | icon | Set a custom icon for the push, the set icon will replace the default Bark icon. <br>The icon will be automatically cached on the device, the same icon URL will only be downloaded once. |
The icon will be automatically cached on the device, the same icon URL will only be downloaded once. | | group | Group messages, pushes will be displayed in the notification center by group.<br>You can also choose to view different groups in the history message list. |
| group | Group messages, pushes will be displayed in the notification center by group.<br />
You can also choose to view different groups in the history message list. |
| ciphertext | Ciphertext for encrypted push | | ciphertext | Ciphertext for encrypted push |
| isArchive | Pass 1 to save the push, pass other values to not save the push, if not passed, it will be decided by the APP settings whether to save. | | isArchive | Pass 1 to save the push, pass other values to not save the push, if not passed, it will be decided by the APP settings whether to save. |
| url | URL to jump to when the push is clicked, supports URL Scheme and Universal Link | | url | URL to jump to when the push is clicked, supports URL Scheme and Universal Link |