PushLink API Documentation

概要

PushLink APIを使用すると、アプリケーションやサービスからユーザーにプッシュ通知を送信できます。 RESTful APIとして設計されており、HTTPSを使用して安全に通信します。

ベースURL: https://push.plusvision.app/api/v1

認証

すべてのAPI リクエストには、Bearer トークンを使用した認証が必要です。トークンはHTTPヘッダーに含めて送信します。

リクエストヘッダー例:

Authorization: Bearer YOUR_API_KEY

注意: APIキーは秘密情報です。公開リポジトリやクライアントサイドのコードに含めないでください。

Messages API

POST /api/v1/messages

ユーザーのデバイスにプッシュ通知を送信します。

リクエストパラメータ

パラメータ	型	必須	説明
`title`	string	任意	通知のタイトル
`message`	string	必須	通知の本文メッセージ
`url`	string	任意	通知に添付するURL
`url_title`	string	任意	URLのタイトル（urlパラメータと併用）
`device_name`	string	任意	送信先デバイス名（未指定の場合は全デバイスに送信）
`ttl`	integer	任意	メッセージの有効期限（秒単位）。指定すると、その秒数が経過した後にメッセージが自動削除されます。例: 60秒後に削除する場合は "60" を指定

リクエスト例

cURL:

curl -X POST https://push.plusvision.app/api/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "重要なお知らせ",
    "message": "新しい機能がリリースされました",
    "url": "https://example.com/news",
    "url_title": "詳細を見る",
    "ttl": 3600
  }'

補足: 上記の例では、ttlパラメータに3600秒（1時間）を指定しています。このメッセージは送信から1時間後に自動削除されます。

TTL（有効期限）の使用例

ttlパラメータを使用すると、メッセージに有効期限を設定できます。期限を過ぎたメッセージは自動的に削除されます。

60秒後に自動削除されるメッセージ:

curl -X POST https://push.plusvision.app/api/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "message=ドアが開いています" \
  -F "ttl=60"

1時間後に自動削除されるメッセージ:

curl -X POST https://push.plusvision.app/api/v1/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "title=一時的なお知らせ" \
  -F "message=メンテナンス中です" \
  -F "ttl=3600"

ヒント: TTLを指定しない場合、メッセージは永続的に保存されます。一時的な通知や期限付きの情報にはTTLの使用を推奨します。

レスポンス

成功時 (200 OK)

{
  "status": 1
}

エラー時

401 Unauthorized (認証エラー):

{
  "status": 0,
  "errors": ["無効なトークンです"]
}

400 Bad Request (パラメータエラー):

{
  "status": 0,
  "errors": ["指定されたデバイスが見つかりません"]
}

制限事項

すべてのAPI通信はHTTPSで行う必要があります
APIキーは秘密情報として厳重に管理してください
リクエストレート制限が適用される場合があります

HTTPステータスコード

ステータスコード	説明
200 OK	リクエストが正常に処理されました
400 Bad Request	リクエストパラメータが不正です
401 Unauthorized	認証に失敗しました
500 Internal Server Error	サーバー内部エラーが発生しました