PUSH API · v1a
リクエストとレスポンス
リクエストのルール
- JSON本文にはContent-Type: application/jsonを使います。記載されたフィールド名とenumの大文字・小文字をそのまま使ってください。
- 未定義のリクエストフィールドは422で拒否されます。レスポンスにはフィールドが追加されることがあるため、未知のレスポンスフィールドは無視できるようにしてください。
- Kits-Idempotency-Keyは、操作の仕様で必須とされる場合に使います。本文や論理的な操作を変えたあとに、同じキーを再利用しないでください。
- Kits-Request-Idは追跡用であり、重複送信の防止キーではありません。診断のためにレスポンスのリクエストIDを保存してください。
- v1aはETag/If-Matchによる同時更新制御には対応していません。各操作で定義されたexpected_*の入力と競合レスポンスに従ってください。
読み取り専用の認証確認
以下は認証が必要なenumレジストリの読み取りです。ネットワーク接続と認証を確認するもので、プッシュサービスの準備状態や端末への配信を検証するものではありません。
curl --include \
--header "Authorization: Bearer ${KITS_SERVER_KEY}" \
"${KITS_API_ORIGIN}/v1/registry/enums"成功と部分的な結果
メッセージの受付・プッシュサービスの処理・端末での確認は別々の段階です。状態・集計値・ignored_fields・ページ情報を読み取ってください。不明な結果を勝手に成功や失敗に置き換えないでください。
正確なリクエスト・レスポンス構造
APIリファレンスは公開OpenAPIとエンドポイントの仕様から生成しています。必須入力・任意フィールド・型・範囲・認証の選択肢・レスポンスごとのJSON Schemaを確認できます。仕様にない成功レスポンス本文を補って表示することはありません。
APIリファレンスを開く