API機能
API機能とは
※ビジネスプラン以上でご利用いただける機能です。
※スタンダードプランは、拡張機能のお申し込みにより利用が可能です。
本APIは、アフィリコード・システムが提供するデータを外部のアプリケーションやプログラムから扱うための機能を提供するインターフェースです。
APIで取得した情報を利用して、ASP運用者が新しいサービスを展開することができます。
- アフィリエイターやインフルエンサー向けに自社独自のレポート管理システムを構築
- コンバージョン計測の仕組みを活用したポイントサイト構築
- ECサイトへの友だち紹介機能
API機能の詳細な仕様については、仕様書を別途用意しております。
製品サイトお問い合わせフォーム よりお気軽にお問い合わせください。
APIキーの取得
APIの利用に際し、OAuthアクセストークンで認証を行います。
管理者のアカウント詳細画面よりAPIキー（アクセスキー、シークレットキー）を取得し、リクエストヘッダに設定します。※シークレットキーは管理画面より再発行が可能。
リクエストヘッダの書式
- X-Auth-Token アクセスキー:シークレットキー ※コロンで結合
対象データと操作
HTTP通信を利用し、RESTful APIのガイドラインに沿って設計されています。リクエストURIに要求された情報を付与し、該当データをJSON形式で返却します。
2023年2月現在、APIは以下の情報が扱えます。
| API | HTTPメソッド | ||
|---|---|---|---|
| 成果計測 | アクセスログ | 取得（集計値・複数） | GET |
| クリック報酬 | 取得（集計値・複数） | GET | |
| インプレッション | 取得（集計値・複数） | GET | |
| 成果報酬 | 取得（集計値・１件・複数） | GET | |
| アフィリエイター | アフィリエイター | 登録 | POST |
| 編集 | PUT | ||
| 取得（１件・複数） | GET | ||
| グループ | 取得（１件・複数） | GET | |
| メディア | 登録 | POST | |
| 編集 | PUT | ||
| 取得（１件・複数） | GET | ||
| メディアカテゴリー | 取得（１件・複数） | GET | |
| メディアタイプ | 取得（１件・複数） | GET | |
| Facebook広告ピクセル | 取得（１件・複数） | GET | |
| 配信管理 | 広告枠 | 登録 | POST |
| 取得（１件・複数） | GET | ||
| 配信条件 | 取得（１件・複数） | GET | |
| 配信素材 | 登録 | POST | |
| 取得（１件・複数） | GET | ||
| SSP | 取得（１件・複数） | GET | |
| 広告 | 広告主 | 取得（１件・複数） | GET |
| 広告 | 登録 | POST | |
| 編集 | PUT | ||
| 取得（１件・複数） | GET | ||
| 広告カテゴリー | 取得（１件・複数） | GET | |
| 広告デバイス | 取得（１件・複数） | GET | |
| 広告アイコン | 取得（１件・複数） | GET | |
| 広告素材 | 登録 | POST | |
| 編集 | PUT | ||
| 取得（１件・複数） | GET | ||
| 提携申請 | 登録 | POST | |
| 編集 | PUT | ||
| 取得（１件・複数） | GET | ||
| 利用拒否 | 取得（１件・複数） | GET | |
| 限定公開 | 取得（１件・複数） | GET | |
| 特別単価 | 取得（１件・複数） | GET | |
| 報酬テーブル | 取得（１件・複数） | GET | |
| 商品テーブル | 取得（１件・複数） | GET | |
| 商品テーブル（特別単価） | 取得（１件・複数） | GET | |
| 単価変更予約 | 取得（１件・複数） | GET | |
| バナーサイズ | 取得（１件・複数） | GET | |
| 動画サイズ | 取得（１件・複数） | GET | |
| システム | システム情報 | 取得（１件） | GET |
製品バージョンとAPIのバージョン 対象表
| 製品バージョン（リリ―ス日） | APIのバージョン（ドキュメントVer.) |
|---|---|
| Ver.3.7（2021.04.30） | v1（1.0） |
| Ver.3.8（2021.08.25） | v1（1.1） |
| Ver.3.9（2022.02.04） | v1（1.2） |
| Ver.3.10（2022.07.12） | v1（1.3） |
| Ver.3.11（2022.11.11） | v1（1.4） |
| Ver.3.12（2023.02.03） | v1（1.5） |
| Ver.3.13（2023.07.10） | v1（1.6） |
