概要
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 | 任意 | 送信先デバイス名（未指定の場合は全デバイスに送信） |
リクエスト例
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": "詳細を見る"
}'レスポンス
成功時 (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 | サーバー内部エラーが発生しました |