PUSH API · v1a
認証とキー
公開APIの認証には、HTTPSのAuthorization: Bearerヘッダーを使います。キーの値をURL・ログ・スクリーンショット・サポートへの問い合わせに含めないでください。
| 認証情報の種類 | 保管する場所 | 用途 |
|---|---|---|
pk_test_… / pk_live_… | アプリのSDK設定 | 公開キーです。installations:enroll権限でインストールを登録します。メッセージの送信やユーザーの再紐付けには使えません。 |
sk_test_… / sk_live_… | 信頼できるバックエンドのシークレット保管領域 | サーバーキーです。付与された権限の操作だけを実行できます。アプリ・ブラウザー・公開ドキュメントには埋め込まないでください。 |
gsk_test_… / gsk_live_… | 信頼できるバックエンドのシークレット保管領域 | 統合送信キー。同じプロジェクト環境の選択した2〜8個のアプリへ/v1/project-messagesで送信を受け付けます。既存のアプリ別キーとSDKキーはそのまま使えます。アプリに埋め込まないでください。 |
it_… | SDKが管理する端末内のストレージ | インストール登録時に返される秘密のトークンです。自身のインストールに対する対応済みの変更だけを許可し、ほかのインストールには使えません。 |
| FCM/APNs認証情報 | 運営者が管理するプッシュサービス接続 | プッシュサービスへの認証に使うシークレットです。Kitsの公開キー・サーバーキーとは異なり、SDKには設定しません。 |
| ダッシュボードのログインセッション | ダッシュボードを開くブラウザー | 管理画面を操作する人のためのセッションです。サーバーキーの代わりにはならず、SDKのAPIオリジンとしても使いません。 |
キーと環境を合わせる
- アプリ別キーと対象のインストールは同じアプリ環境に属している必要があります。統合送信キーは、発行時に選択した同じプロジェクト環境のアプリだけに使用できます。
- テスト送信にはmessages:send、結果の確認にはmessages:readを使います。必要な権限だけを付与しましょう。
- 顧客向けSDKの接続先はhttps://kits-api.marco-corp.comに固定されます。URLやHTTP許可の設定はありません。curlのAPI originはSDK初期化オプションではありません。
- 新しい管理型連携のストレージはSDKが管理します。以下の旧core連携を維持するアプリだけ、互換経路で以前のstorageNamespaceを保持してください。キー交換やアプリ更新時にストレージの名前を変えたり削除したりしないでください。
権限を確認する
APIリファレンスには、利用できる認証方式と必要な権限が記載されています。ORで区切られた項目は選択肢であり、すべてを同時に満たす必要はありません。
操作ごとの権限を見る