仕組み
Ahrefs Connect を使うと、Ahrefs アカウントを貴社プロダクトに接続したユーザーに代わって、アプリが Ahrefs API データへアクセスできます。
基本的な流れは次のとおりです。
- 貴社アプリは OAuth を介して Ahrefs API と連携します。
- 有料の Ahrefs サブスクリプションを持つ共通ユーザーが、アカウントを貴社アプリに接続します。
- 貴社アプリが、そのユーザーに代わって Ahrefs データをリクエストします。
- 各リクエストで、ユーザーの月次割り当てから API ユニットが消費されます。
- 貴社アプリ内でそのデータを処理・保存し、そのユーザーに表示します。
参加要件
Ahrefs Connect に参加する開発者に、サブスクリプションプランの要件はありません。アプリは次の要件を満たす必要があります：
- 既存のユーザーベースがある、一般公開されているプロダクトであること。個人的または社内利用のために Ahrefs データが必要な場合は、代わりに Ahrefs API を直接ご利用ください。
- Ahrefs と直接競合しないこと、および当社の機能をコピーしないこと。
- 有料アカウントを持つ個々の Ahrefs ユーザーに代わってのみデータをリクエストすること。 Ahrefs Connect は、各閲覧者が Ahrefs ユーザーでなくても一般の閲覧者に Ahrefs データを表示したいプロダクト向けには設計されていません。
手順
1. アプリケーション
以下を添えて 申請フォーム を提出してください。
- プロダクトの説明
- ウェブサイトへのリンク
- アプリ内で Ahrefs データをどのように利用する予定かの詳細
弊社のチームが、プロダクトが対象となるかどうかを確認し、手順をご説明し、サポートを提供します。
2. 開発
設定が完了すると、アカウント設定 に Ahrefs Connect セクションが表示されます。このページには、OAuth実装の詳細が記載されています：
- クライアントIDとシークレット
- ステージング環境と本番環境のリダイレクトURIを設定するための項目
この段階では、アプリのステータスは 非アクティブ となっており、次のことが可能です：
- ステージング環境でOAuthフローをテストする
- API v3エンドポイントに無料のテストリクエストを送信する
ナレッジベース:
開発中に不明点があれば、[email protected] または連絡を取っている営業担当者までお問い合わせください。
3. レビュー
開発が完了したら、サポートまたは営業チームにご連絡ください。提出手順と、承認要件の詳細をご案内します。
詳細: 承認プロセス
4. 有効化
承認されると、アプリは アクティブ に切り替わります。これにより、以下が可能になります：
- 本番環境でAhrefsユーザー向けにOAuth接続を稼働させる
- 本番環境でのAPIリクエストへのフルアクセス
また、営業チームがアプリを アプリギャラリー に追加できるため、ユーザーが簡単に見つけられるようになります。これには、掲載情報の追加記入が必要です：Apps Gallery ガイド