AirbridgeはAPIを使って広告成果を最大化できる環境を提供しています。AirbridgeのAPIはREST基盤で、リソース指向としてURLを使用します。JSON形式でデータを返却し、標準のHTTPステータスコードおよび認証を適用しています。

AirbridgeのAPIに使われる基本URLは下記のような形です。

全てのリクエストはHTTPSで実施する必要があります。一般のHTTPプロトコルでの呼び出し、認証のないAPIリクエストは全てエラーを返却します。

https://api.airbridge.io

AirbridgeのAPIリクエストには次のヘッダーが含まれます。

Content-Type: application/json; charset=utf-8
Authorization: Bearer {AIRBRIDGE-API-TOKEN}

全てのリクエストには基本的にContent-Typeのヘッダーが必要です。

認証のためのトークンはAuthorizationヘッダーで送信することができます。

Airbridge APIはAPIキーを使って認証リクエストをします。Airbridgeダッシュボードの[Settings] > [Tokens]にてAPIキーを確認、管理することができます。

細かい権限管理のために役割が制限されたトークンが存在します。

APIトークンは全てのAPI呼び出しに使うことができます。このトークンは広範囲なアクセス権限を持っているため、公開的な場所にAPIトークンを露出しないようご注意ください。

トラッキングリンクのAPIトークンはトラッキングリンクの作成に使うAPIです。クライアントでトラッキングリンクを作成する場合、このトークンを利用することができます。

もしトークンが流出してしまった場合、[Settings]>[Tokens]にて再作成することができます。この時、既存のトークンは自動で廃棄され、当該トークンを使用していた全てのAPIから認証エラーが返ってきます。トークンの再作成は慎重に行ってください。

PostmanはAPIの利用に役立つAPIクライアントサービスです。Airbridgeと簡単に連携できるよう、Postmanコレクションを提供しています。

Postmanコレクションを利用するためにはコレクションをフォークしたあと、{{api_key}}の値を入力します。

APIトークンとアプリ名をAirbridgeダッシュボードからコピーし、Initial Valueに入力します。