API連携ガイド
コネクテッドコンテンツで呼び出すAPIを開発・点検する開発チーム向けの内容です。マーケターには、APIのURL、リクエスト方式、認証方式、レスポンス例(JSON)を共有してください。
APIの要件
Section titled “APIの要件”| 区分 | 要件 |
|---|---|
| スキーム・ポート | http または https、標準ポート(80、443)のみ呼び出します |
| プライベートネットワーク | 社内ネットワーク・内部IPは呼び出せません。外部からアクセス可能なURLである必要があります |
| URL | 変数の置換後で2048文字以下。user:pass@ の形式で認証情報を含めることはできません(認証情報の登録を使用) |
| リダイレクト | 3xxには従いません。最終的なURLを指定してください |
| 成功の判定 | 2xxのみ成功です。4xx・5xxは本文があっても失敗として処理します |
| 応答時間・サイズ | 2秒以内、1MB以下 |
| レスポンス形式 | JSONオブジェクトを推奨します。プレーンテキストも使えます |
| JSONレスポンスのヘッダー | · JSONとして使うには、必ず Content-Type: application/json を付けてください· ヘッダーがない場合や text/plain の場合は、本文がJSONでもテキストとして処理します· JSONと宣言しているのに本文がJSONでない場合は、失敗として処理します |
送信元IPとリクエストヘッダー
Section titled “送信元IPとリクエストヘッダー”FlareLaneは固定IPから呼び出します。ファイアウォールでアクセスを制限している場合は、担当マネージャーから送信元IPを受け取り、許可リストに追加してください。すべての呼び出しには以下のヘッダーが付きます。
| ヘッダー | 値 |
|---|---|
User-Agent | FlareLane-ConnectedContent/1.0 |
X-flarelane-connected-content-request-id | リクエストごとに異なる一意のID |
X-flarelane-connected-content-request-timestamp | リクエスト時刻(ISO 8601) |
呼び出し量と重複リクエスト
Section titled “呼び出し量と重複リクエスト”- 呼び出し数は受信者数と同じではありません。ディレクティブごとに呼び出され、再処理時に再度呼び出されることがあり、キャッシュによって減ることもあります。
- 大量配信に使うAPIであれば、受信者数より多いリクエストにも耐えられる必要があります。429レスポンスが繰り返されると、サーキットブレーカーが作動する原因になります。
- クーポン発行のように呼び出しのたびに結果が生じるAPIは、同じリクエストが再度届いても結果が重複しないようにしてください。例: すでに発行したクーポンをそのまま返す
サーバーログで原因を探す
Section titled “サーバーログで原因を探す”呼び出しが失敗すると、メッセージには空欄だけが残ります。サーバーログで、FlareLaneからのリクエスト(User-Agent とリクエストIDヘッダーで識別)のレスポンスコードを確認してください。
| レスポンスコード | 確認すること |
|---|---|
| 400 | bodyの形式がAPIの想定する形式と合っているか。JSONの場合は推奨される書き方に従っているか |
| 401 | 認証情報の値(ID・PW・ヘッダー値)が正しいか |
| 403 | 送信元IPを許可しているか、User-Agent をブロックしていないか、トークンにそのAPIの権限があるか |
| 404 | URLとパスに入れた変数の値が正しいか |
| 405 | :method がAPIの受け付ける方式と同じか |
| 429 | 処理上限を超えていないか。繰り返されるとサーキットブレーカーが作動する原因になります |
| 5xx | サーバーエラーです。502・503・504が繰り返されるとサーキットブレーカーが作動する原因になります |