デジタル プラットフォーム API - 認証プロセス

  • [アーティクル]

Digital Platform API サービスまたはレポートを呼び出す前に、ユーザー名とパスワードを使用して承認トークンを取得する必要があります。 トークンは 2 時間アクティブのままであり、その間は再認証する必要はありません。 さらに、24 時間のハード有効期限があります。 API セッションが 24 時間に達すると、最新の API 呼び出しがいつ行われたかに関係なく、そのセッションは期限切れになります。

このページでは、認証プロセスについて説明します。

注:

  • 認証中および認証後に発生する可能性があるエラーの詳細については、「 エラー メッセージ」を参照してください。
  • ユーザー名とパスワードによって API へのアクセスが許可されない場合は、 API オンボード プロセス を参照するか、Xandr の担当者にお問い合わせください。
  • ユーザー名またはパスワードを忘れた場合は、 アカウント回復サービス を使用してユーザー名を取得するか、新しいパスワードを作成できます。

手順 1. ユーザー名とパスワードを含む JSON ファイルを作成する

次に、 cat コマンドを使用して、ファイルの出力を表示します。

$ cat auth
{
    "auth": {
        "username" : "USERNAME",
        "password" : "PASSWORD"
    }
}

パスワードを作成するためのガイドライン

パスワードを作成するときは、次の複雑なパスワードを作成してください。

  • 10 文字以上
  • 64 文字以下
  • 少なくとも 1 つの大文字 (A から Z)
  • 少なくとも 1 つの小文字 (a から z)
  • 少なくとも 1 桁 (0 から 9)
  • 少なくとも 1 つの特殊文字 (#、$、? %、& など)

手順 2. POST 認証サービスへのファイル

要求は、API への最新の呼び出しの後の 2 時間有効なトークンを返します。 POST要求で "-b cookies -c cookies" を使用して、トークンを Cookie に格納することをお勧めします。

$ curl -b cookies -c cookies -X POST -d @auth 'https://api.appnexus.com/auth'
{
    "response": {
        "status": "OK",
        "token": "h20hbtptiv3vlp1rkm3ve1qig0",
        "dbg_info": {
            ...
        }
    }
}

手順 3. API サービスとレポートを呼び出すときにトークンを使用する

次の例では、 メンバー サービス を呼び出し、Cookie に格納されているトークンを使用して認証します。

$ curl -b cookies -c cookies 'https://api.appnexus.com/member'
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

または、Cookie にトークンを格納しなかった場合は、トークンを要求ヘッダーに "Authorization: TOKEN"として配置できます。

$ curl -H "Authorization: 622cee5f8c99c81e87614e9efc63eddb" 'https://api.appnexus.com/member'
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Member 1",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

注:

セキュリティを強化するために、JSON Web トークンを使用して認証することもできます。 詳細については、「 トークン ベースの API 認証」 を参照してください。

認証頻度

認証後、トークンは 2 時間有効なままになります。 この時間内に再認証する必要はありません。 再認証を行う場合は、次の制限事項に注意してください。API を使用すると、5 分間に 10 回正常に認証できます。 この 5 分以内にそれ以降の認証が試行されると、エラーが発生します。

ヒント

通話応答で "NOAUTH"error_id をリッスンし、受信した後にのみ再認証することをお勧めします。