Impression Bus API 認証

Impression Bus API を使用する前に、ユーザー名とパスワードを使用して承認トークンを取得する必要があります。 トークンを取得するには、認証資格情報を含む JSON ファイルを使用してhttps://api.adnxs.com/authするPOST要求を行います。

これにより、トークンを含む JSON 応答が返されます。 その後、次の 2 つのオプションがあります。

• 将来の要求でトークンを "承認" としてヘッダーに配置する: TOKEN または
• 以下で説明する方法( 推奨)を使用してクッキーに入れます。

ユーザー名とパスワードがない場合は、Xandr アカウントの担当者にお問い合わせください。

期限

認証すると、最新の呼び出しの後 2 時間アクティブな状態の承認トークンを受け取ります。 呼び出し応答で "NOAUTH"``error_id を受信した後にのみ、再認証することをお勧めします。 この方法に従う場合、上記の制限は実装に影響を与えるべきではありません。

さらに、サービスによって 24 時間のハード 有効期限が追加されます。 API セッションが 24 時間マークに達すると、最新の API 呼び出しがいつ行われたかに関係なく、そのセッションは期限切れになります。 クライアント側の非アクティブ状態が 2 時間後にセッションが期限切れになる現在の動作は変更されません。 API ベスト プラクティスのガイドラインに従うプログラムは影響を受けないようにしてください。

認証方法

手順 1: autnetication JSON を作成する

ユーザー名とパスワードを使用して JSON 形式のテキスト ファイルを作成します。 次に、 cat コマンドを使用して、サンプル ファイルの出力を示します。

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

手順 2: 要求を POST する

"auth" ファイルを使用して POST 要求を行います。 承認要求はどちらもセッション Cookie (IBAPI_SESSID) を設定し、JSON でトークンを返します。 次の例では、"verbose" パラメーターを使用しました。

curl -v -X POST --data-binary @auth https://api.adnxs.com/auth
< HTTP/1.1 200 OK
< Date: Fri, 22 Aug 2008 12:12:13 GMT
< Set-Cookie: IBAPI_SESSID=622cee5f8c99c81e87614e9efc63eddb; path=/
< Content-Length: 58
< Content-Type: text/html
<
{
    "response": {
        "token": "622cee5f8c99c81e87614e9efc63eddb"
    }
}

手順 3: API 呼び出しにトークンを使用する

トークンを使用して API からの要求を行うようになりました。

$ curl -H "Authorization: 622cee5f8c99c81e87614e9efc63eddb" https://api.adnxs.com/member
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

または、Cookie を使用することもできます。 これは、この例で使用する推奨される方法と表記法です。 メンバー サービスの使用例を次に示します。

$ curl -b cookies -c cookies -X POST -d @auth "https://api.adnxs.com/auth"
{
    "response": {
        "token": "622cee5f8c99c81e87614e9efc63eddb"
    }
}
$ curl -b cookies https://api.adnxs.com/member
{
    "response": {
        "members": [
            {
                "id": "1",
                "name": "Car company c\/o Ad Agency",
                "active": "1",
                "bidder_id": "2"
            }
        ]
    }
}

認証頻度

認証後、トークンは 2 時間有効なままになります。 この時間内に再認証する必要はありません。