概要：代理店は自社の正式名称で一度だけ登録し、会員向け表示名に各クライアントの名前を入力することで、クライアントの広告を出せます。支払い、残高の管理、請求書の受け取りは代理店が行います。開発者は、広告ポータルで発行したAPIキーを使い、Agilis REST API（https://ads.agilis.dating）から特典やイベントを作成・管理できます。テスト用キーは無料で、会員に表示されることはありません。
代理店の方へ
- 代理店自身の正式名称で代理店を登録します。→ 登録方法
- 特典やイベントを作成する際は、会員向け表示名に会員向け表示名を入力します。会員には、貴社ではなくクライアントの名前が表示されます。
- 広告を出すには、各クライアントから許可を得ている必要があります。広告掲載規約では、この点について代理店が責任を負うものと定めています。
支払いと請求書の宛先
- 支払いは代理店のアカウントから、代理店の請求通貨で行われます。
- 代理店の各メンバーはそれぞれ自分の残高を持ち、そこから支払います。組織の残高はその合計です。→ 残高の仕組み
- 請求書と成果データは代理店名義で、支払いごとに1通発行されます。各クライアントへの再請求にご利用ください。
- クライアントごとの費用を分けて管理するには、クライアントごとに別の特典やイベントを使い、その請求書をもとに再請求してください。
チームの役割
組織管理者と広告担当者は広告ポータルで、開発者はAPIで作業します。開発者は広告ポータルでは特典やイベントを作成できませんが、自分のAPIキーを使えばAPI経由で作成・公開・支払いができます。キーの使われ方については貴社が責任を負います。一覧表はチームの役割と権限をご覧ください。
Agilis REST API
- ベースURL：https://ads.agilis.dating
- リファレンス：www.agilis.dating/api-doc（cURL、Python、Node.js、PHPのサンプルとAPIアシスタントあり）
- 機械可読形式：OpenAPI 3.1はwww.agilis.dating/openapi.json、Markdownはwww.agilis.dating/api-doc.md、AIツール向けの全文はwww.agilis.dating/llms-full.txt
- 特典：カテゴリーと興味・関心の一覧取得、作成前の料金見積もり、特典の作成・一覧表示・一時停止・再開・削除、各特典の成果の取得
- イベント：イベントのプレビュー・公開・一覧表示・編集・日程変更・中止・削除、各イベントの成果の取得
APIキーを取得する
- 組織管理者または開発者として広告ポータルにログインします。
- ページ上部の切り替えスイッチで、テストモードか本番モードを選びます。
- APIキー → 新しいキーを作成に進み、キーの名前と、必要に応じて有効期限を設定します。
- キーはすぐにコピーしてください。後から再表示することはできません。
テスト用キーはpk_test_、本番用キーはpk_live_で始まります。キーは1人につき各モードで最大10個まで作成できます。キーを再発行すると、そのキーはすぐに置き換わるため、先にお使いのシステム側を更新してください。キーはx-api-keyリクエストヘッダーで送信します：x-api-key: pk_test_…
安全に開発する
- 開発とテストには
pk_test_キーをお使いください。テスト用の特典やイベントは無料で、会員に表示されることはありません。 - 特典を作成する前に、料金見積もりエンドポイントで料金を確認してください。
- キーはコードリポジトリやブラウザに置かず、APIはサーバーから呼び出してください。
よくある質問
代理店は1つのアカウントで複数のクライアントを管理できますか？
はい。代理店として一度登録し、特典やイベントごとにクライアント名を指定してください。
クライアントごとに請求書を分けられますか？
請求書は代理店宛てに、支払いごとに1通発行されます。それをもとに各クライアントへ再請求してください。
サンドボックスはありますか？
はい。pk_test_キーを使うテストモードが、完全なサンドボックスとして機能します。料金は一切発生せず、会員に表示されることもありません。
AIコーディングツールと連携できますか？
はい。ツールの参照先をwww.agilis.dating/api-doc.mdまたはwww.agilis.dating/openapi.jsonに設定してください。
