アクセス認証
正当なユースケースがあるビジネスだけが別のビジネスのビジネスデータにアクセスできるようにするため、一部のAPIエンドポイントは、ビジネスによって作成または取得されたアプリによって呼び出されるか、まだビジネスにリンクされていないビジネスアプリによって呼び出されると、認証チェックを実行します。アプリを作成したか、取得したか、アプリにリンクされているビジネスが技術提供者として認証されているなら、エンドポイントは通常そのリクエストを処理します。しかし、ビジネスが技術提供者として認証されていない場合、エンドポイントは呼び出しを却下しエラーを返します。
アクセス認証は、ビジネスが技術提供者として経営しているかどうかを判断するための処理です。
アクセス許可
認証チェック
ビジネスが取得したアプリが、上記のいずれかのアクセス許可を要求するエンドポイントを呼び出すと、そのエンドポイントはまず、アクセス許可を付与した人がアプリそのものに対して権限を持っているかどうかをチェックします。その人がアプリに対して権限を持っている場合、エンドポイントは呼び出しを承認してリクエストの処理を続行します。
しかし、その人がアプリに対して権限を持っていない場合、エンドポイントは、アプリを取得しているビジネスが技術提供者として認証されているかどうかをチェックします。ビジネスが技術提供者として認証されている場合、エンドポイントはリクエストを通常通り処理します。認証されていない場合は、呼び出しを却下し次のエラーを返します。
- エラーコード:
100 - 説明:
Unsupported get request. Object with ID{object-id}does not exist, cannot be loaded due to missing permissions, or does not support this operation.
エラーコードの詳細については、マーケティングAPIエラーコードのドキュメントを参照してください。
認証チェックは、アプリの取得者であるビジネスに対して実行されますが、そのビジネスが取得したアプリが、認証チェックが実装されているエンドポイントを呼び出した場合にのみトリガーされます。つまり、ビジネスが技術提供者として認証されれば、そのビジネスが取得したアプリは認証チェックに合格するということです。
アクセス認証を行う方法
技術提供者として認証されていないビジネスのビジネス管理者が新しいアプリを取得しようとする場合、アプリ管理者が上記のいずれかのアクセス許可のアドバンスアクセスをリクエストすると、アクセス認証要件に関するメール通知を受信します。
メールには認証フォームへのリンクが含まれていますが、フォームへはアプリダッシュボードから[基本] > [認証] > [アクセス認証]パネルに移動してもアクセスできます。
認証を完了するには、そのビジネスで管理者アクセス権限を持つ人が、他のビジネスにサービスを提供するために使用するそれらのビジネスのデータについて、その利用方法を分類、説明しなければなりません。
ビジネス管理者がこのプロセスを完了すると、おおよそ5日以内に決定が行われます。
ビジネスが技術提供者として認証された場合、ビジネス管理者は確認のメールを受け取り、アプリ管理者は確認の開発者アラートを受け取ります。認証されたビジネスが再度認証を受ける必要はありませんが、状況によっては、一時的に認証済みステータスを喪失する可能性があります。
技術提供者認証で却下された場合、ビジネス管理者は却下のメールを受け取り、アプリ管理者は却下の開発者アラートを受け取ります。上記のアクセス許可を必要とするエントリポイントへのすべての呼び出しは、アプリユーザーが呼び出し側のアプリに対して権限を持っていない場合、失敗します。
却下されたビジネスのユースケースが変更された場合、ビジネス管理者は再度このプロセスを行って再審査してもらえます。
前提条件
ビジネス管理者がアクセス認証プロセスを開始するには、次のことが必要です。
既存のビジネス
他のビジネスで使用されているアプリをすでに取得しているビジネスの管理者が上記のアクセス許可のいずれかを必要とする場合、アクセス認証要件に関するメールが自動的に届きます。アプリ管理者も、この要件に関する開発者アラートを受け取ります。
メールが送信されると、ビジネス管理者は60日以内に認証プロセスを完了させなければなりません。60日以内に完了しない場合は、上記のアクセス許可のいずれかを必要とするエントリポイントへの呼び出しは認証チェックを徐々に受けることになります。