MoEngageでは、アクセストークンを取得および更新するOAuth 2.0認証サービスを構成できます。 マーケティング担当者として、カスタムコネクタキャンペーンを作成する際(ステップ2のコンテンツ)やカスタムSMSコネクタを構成する際に、OAuth 2.0を認証として使用できます。詳細については、 コネクタキャンペーンの作成 および カスタムコネクタ(サービスプロバイダー)の構成 をご参照ください。
この記事では、OAuth 2.0 設定の構成と管理方法について説明します。
OAuth 2.0 設定を追加する
- MoEngageダッシュボードに移動し、 設定 > 詳細設定 > 認証設定 を選択します。認証設定ページが表示されます。
-
クリック
+ OAuth構成を追加
。セットアップ認証ページが表示されます。
OAuth 2.0 構成を追加するには、以下の手順が含まれます:
ステップ 1: OAuth の詳細
OAuthの詳細タブに、次の詳細を入力してください:
- OAuth名 : OAuth設定の名前を入力してください。これらの設定は、キャンペーン作成時に選択可能になります。
-
グラントタイプ
: 現在、クライアント資格情報グラントタイプがサポートされています
。他のグラントタイプを使用している場合は、
MoEngageダッシュボードを通じてサポートチケットを提出してください
。
-
トークンタイプ
: トークンタイプを選択してください。サポートされている値は以下の通りです:
- オペーク: トークン発行者がオペークトークンを使用している場合は、このオプションを選択してください。ここでは、発行者からの応答にオペークアクセス トークンとともに有効期限が含まれます。
- JWT: このオプションを選択すると、アクセス トークンと有効期限がステップ 2 応答設定で JSON Web Token (JWT) として応答にエンコードされます。応答をデコードして有効期限を取得する必要があります。
- 以下の APIの詳細 、 アクセストークンを取得するために必要な詳細を提供してください。実装する予定のOAuthサービスのAPIドキュメントを確認してください。
- API URL : API URLを入力してください。
-
メソッド
: APIメソッドを選択します。以下はサポートされているメソッドと各メソッドの利用可能なフィールドです:
メソッド サポートされているフィールド GET - URLパラメータ
- ヘッダー
POST - URLパラメータ
- ヘッダー
- ボディタイプ
PUT - URLパラメータ
- ヘッダー
- ボディタイプ
DELETE - URLパラメータ
- ヘッダー
- ボディタイプ
- URLパラメータ : + KVペア をクリックして、APIのパラメータを入力します。
- ヘッダー : + KVペア をクリックして、APIのヘッダーを入力します。
-
ボディタイプ
: 次のオプションを使用してリクエストのボディを設定します:
Webhookのためのフォームエンコードされたシリアル化に基づいてボディを作成します。 + KVペア をクリックして、さらにフォームエンコードされたボディを追加します。
JSON形式を使用してボディを作成します。 + KVペア をクリックして、さらにJSONコンテンツを追加します。
生のテキスト形式を使用してボディを作成します。
- クリックして テストを送信して続行 し、設定をテストして2番目のステップ「応答設定」に進みます。
info |
Information 「 テストを送信して続行 」をクリックした後にエラーが発生した場合は、OAuthサービスプロバイダーのドキュメントでAPI設定を確認してください。 |
ステップ2: 応答設定
レスポンス設定タブに、以下の詳細を入力してください:
-
OAuth 配信応答
ステップ 1 OAuth 詳細の トークンタイプ ドロップダウンリストから「オペーク」を選択した場合、 OAuth 配信応答 フィールドは 1 つだけ表示されます。OAuth 配信応答には、有効期限のあるキーが含まれており、エンコードされていません。また、応答が受信された日時も確認できます。
有効期限 ドロップダウンリストから有効期限オプションを選択し、2 番目のドロップダウンリストから値を選択します。 有効期限 ドロップダウンリストの値は、受信した応答の種類に依存します。
ステップ 1 OAuth 詳細のトークンタイプ ドロップダウンリストから「JWT」を選択した場合、2 つの OAuth 配信応答 フィールドが表示されます。
最初の OAuth 配信応答 フィールドでは、応答に有効期限のあるキーがありますが、有効期限はエンコードされています。また、応答が受信された日時も確認できます。
アクセストークン ドロップダウンリストから、有効期限のあるキーを選択し、 トークンタイプをデコード をクリックします。トークンタイプがデコードされると、2 番目の OAuth 配信応答 フィールドにもう 1 つの応答が返されます。
有効期限 ドロップダウンリストから有効期限オプションを選択し、2 番目のドロップダウンリストから値を選択します。 有効期限 ドロップダウンリストの値は、受信した応答の種類に依存します。
-
推奨プレフィックス
: OAuth設定の推奨プレフィックスを選択します。
マーケターはデフォルトオプションに加えてカスタムプレフィックスを作成できます。これらのプレフィックスは、カスタムコネクタを作成する際や、 カスタムSMSコネクタ を設定する際に使用でき、キャンペーンレベルで上書きすることができます。 - 優先エラーコード : OAuthエラーコード フィールドに、トークンの期限切れによる認証失敗のためのOAuth設定の優先エラーコードを入力します。このエラーコードは、コネクタキャンペーンまたは カスタムSMSコネクタ を再試行するために使用できます。
- クリックして 保存 。現在、このOauth設定はアクティブです。このOauth構成を使用して、 カスタムコネクターキャンペーンを作成 するか、 カスタムSMSコネクターを構成 できます。
OAuth設定を管理する
-
MoEngage ダッシュボードに移動し、
設定
>
詳細設定
>
認証設定
を選択します。認証設定ページが表示されます。既存の OAuth 設定が表示されます。
info 情報
「失敗した」OAuth設定は、OAuth構成が応答を取得できないことを意味します。OAuth構成を編集し、再度テストを送信する必要があります。コネクターキャンペーンを作成したり、カスタムSMSコネクターを構成したりする際に、失敗したOAuth設定を使用しないでください。
- OAuth設定を編集するには、必要なOAuth設定の省略記号アイコンをクリックし、 編集 をクリックします。
-
OAuth設定を削除するには、必要なOAuth設定の省略記号アイコンをクリックし、
削除
をクリックします。OAuth設定に関連付けられているキャンペーンがある場合、それを削除することはできません。関連するキャンペーンのリストと共に警告が表示されます。