From 2ab213faa1afb0f31bf366ab85b3e22711998dae Mon Sep 17 00:00:00 2001 From: bannzai Date: Wed, 23 Sep 2026 23:41:06 +0900 Subject: [PATCH] =?UTF-8?q?API=20=E3=83=AA=E3=83=95=E3=82=A1=E3=83=AC?= =?UTF-8?q?=E3=83=B3=E3=82=B9=E3=81=AE=E7=AB=AF=E6=9C=AB=E6=95=B0=E3=81=A8?= =?UTF-8?q?=E5=8F=96=E3=82=8A=E6=B6=88=E3=81=97=E3=81=AE=E9=85=8D=E9=80=81?= =?UTF-8?q?=E5=85=88=E3=82=92=E3=83=97=E3=83=A9=E3=83=B3=E5=88=A5=E3=81=AE?= =?UTF-8?q?=E9=85=8D=E9=80=81=E3=81=AB=E5=90=88=E3=82=8F=E3=81=9B=E3=82=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit #108 でバックエンドがプラン別の配送先 (無料は最初に登録した 1 台、Pro は登録済みの全端末) を強制するようになったため、docs/api.md の Limits 表と取り消しの説明を実装に揃える。 - Limits 表の「Devices per account | 20 | 20」を、アラームを受け取る端末の行 (無料 1 台 / Pro 全端末・上限 20 台) に変えた - 「A plan-specific device limit is not enforced yet」を削除し、無料では 2 台目以降が登録されたまま受信しないこと、Pro 失効時は最初の 1 台へ戻ることを書いた - DELETE の取り消しは取り消し時点のプランの配送先へ届くため (#108)、登録を外した端末に加えて Pro 失効で受信しなくなった端末のアラームも解除されない旨を書いた --- docs/api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index 1e6e920..7abb087 100644 --- a/docs/api.md +++ b/docs/api.md @@ -93,7 +93,7 @@ curl -X DELETE https://api.signalarm.app/v1/alarms/3b0e0c6e-9f1b-4c0a-9e7d-1f2a3 `200 OK` with the same body as `POST /v1/alarms`, with `"status": "canceled"`. Cancelling an alarm that was already cancelled returns the same response, so retries are safe. -The cancellation only reaches the devices that are registered when you send the request. If a device was unregistered after the alarm was scheduled, the alarm already on that device is not cancelled and still rings; cancel it from the alarm list in the app. +The cancellation only reaches the devices that receive alarms when you send the request (see Limits below). If a device was unregistered, or stopped receiving alarms because a Pro subscription ended, after the alarm was scheduled, the alarm already on that device is not cancelled and still rings; cancel it from the alarm list in the app. ### Errors @@ -125,10 +125,10 @@ Unexpected server failures use `500` with `"code": "internal"`. | --- | --- | --- | | Alarms per calendar month (UTC) | 50 | 1000 | | API tokens | 1 | Multiple (one per system) | -| Devices per account | 20 | 20 | +| Devices that receive alarms | 1 (the first device registered) | All registered devices (up to 20) | | Alarm history in the app | Last 3 alarms | 30 days | -A plan-specific device limit is not enforced yet; both plans share the same cap of 20 registered devices. Requests are rate limited to 60 per minute per token on both plans. Alarm records (for history and cancellation) are kept for 30 days after the alarm fires or is cancelled. +On the Free plan, alarms go only to the first iPhone registered to the account; iPhones registered after it stay on the account but do not receive alarms. When a Pro subscription ends, delivery goes back to the first registered iPhone. Requests are rate limited to 60 per minute per token on both plans. Alarm records (for history and cancellation) are kept for 30 days after the alarm fires or is cancelled. ## Delivery and timing