Yield Analytics API - 認証プロセス

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

API サービスにアクセスする前に認証が必要です。 IMF API はアプリケーションデータを安全に公開し、セキュリティで保護されたトランスポートプロトコル経由で認証されたユーザーのみが使用できます。
IMF API エンドポイントを呼び出す前に、次の場所にある認証サービスを通じて、プラットフォームのユーザー名とパスワードを使用して認証する必要があります。 https://api.appnexus.com/auth。
認証要求が成功すると、2 時間有効な承認トークンが返されます。このトークンは、次のすべてのエンドポイントへの要求に使用できます。 https://api.appnexus.com/imf。
トークンが有効である間は、再認証は必要ありません。
便宜上、認証要求の -b cookies -c cookies オプションを使用して、承認トークンを Cookie に格納することをお勧めします。これにより、トークンは後続のすべての API 呼び出しに自動的に含まれます。

注:

認証のユーザー名とパスワードは、デジタルプラットフォーム API や Microsoft Monetize に使用される資格情報と同じです。

ヒント

ユーザー名またはパスワードを忘れた場合は、アカウント回復サービスを使用してユーザー名を取得するか、新しいパスワードを作成できます。

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

以下では、 cat コマンドを使用してファイルの出力を示します。

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

パスワード作成のガイドライン

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

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

手順 2. `POST` ファイルを認証サービスに送る

要求によって、2 時間有効なトークンが返されます。トークンを Cookie に保存するには、POST 要求で "-b cookies -c cookies" を使用することをお勧めします。

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

手順 3. IMF API サービスの呼び出しを行うときにトークンを使用する

発行されたトークンを使用して、ホストエンドポイント api.appnexus.com/imfで利用可能なすべてのエンドポイントにアクセスできます。

$ curl -b cookies -c cookies 'https://api.appnexus.com/imf/api/v1/rest/data/aliasFunctions'
{
    "response": {
        "aliasFunctions": [
            {
                "name": "ACTIVE_CUSTOM_PRODUCTS",
                "inputs": [
                "ARRAY"
                ]
            },
        ...
        ]
    }
}

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

$ curl -H "Authorization: h3vlp0122344" 'https://api.appnexus.com/imf/api/v1/rest/data/aliasFunctions' 
{
    "response": {
        "aliasFunctions": [
            {
                "name": "ACTIVE_CUSTOM_PRODUCTS",
                "inputs": [
                "ARRAY"
                ]
            },
        ...
        ]
    }
}

認証の頻度

認証後、トークンは 2 時間有効です。この間に再認証する必要はありません。再認証する場合は、次の制限事項に注意してください。

この API を使用すると、5 分間に 10 回正常に認証できます。
この 5 分以内に認証を試行すると、エラーが発生します。

ヒント

通話応答で "NOAUTH"error_id を聞き、受信してから再認証することをお勧めします。

Last updated on 2026-08-18