Exabase Link Preview

Exabase Link Previewは、任意のURLからtitle、description、image、faviconなどのプレビュー用メタデータを取得する開発者向けAPIです。リッチなリンクカード作成に最適です。

概要

Exabase Link Preview は、URL からリッチなメタデータを取得し、構造化された JSON として返す開発者向け API です。アプリ側でページをスクレイピングしたり、別途リソースを作成したりせずに、リンクカードやその他のプレビュー表示を実現できます。

この API は、プレビューに一般的に必要な項目を返します。ページタイトル、description、プレビュー画像、favicon、サイト名、canonical URL、ロケール、および関連する画像やアイコンのメタデータです。製品ページでは、JavaScript でレンダリングされたページも含め、リアルタイムで動作する単一の GET リクエストとして案内されています。

機能

構造化されたプレビューメタデータ

リッチなリンクカードに必要な title、description、image、favicon、site name、canonical URL、locale、source URL などを含む、コンパクトな JSON オブジェクトを返します。

単一の GET リクエストで完結するワークフロー

1 回のリクエストでページを取得し、Open Graph タグや関連メタデータを抽出するため、アプリ側で HTML を自前解析する必要がありません。

JavaScript でレンダリングされたページに対応

ドキュメントでは、JavaScript でレンダリングされたコンテンツを含め、ページをリアルタイムで取得できると説明されています。

詳細なアセット情報

利用可能な場合は、画像や favicon の寸法、MIME type、ファイルサイズを返すため、レイアウトや検証に役立ちます。

即時の JSON レスポンス

同期レスポンスを返すため、アプリ内でリンクカードやプレビューを即座に描画する用途に適しています。

明確なプレビュー不可の扱い

URL からプレビューデータを取得できない場合は 404 を返すとドキュメントに記載されており、未対応ページを明確に判定できます。

ユースケース

チャットやメッセージのプレビュー
ユーザーがチャット、メッセージング、共同作業ソフトウェアに URL を貼り付けたときに、リッチなプレビューを表示します。API は、カード形式の表示に必要な title、description、image、favicon を提供します。
CMS のリンクカード
編集者がリンクを追加したときに、編集ツールや CMS のワークフロー内でプレビューカードを自動生成します。これにより、title や thumbnail データの手入力が不要になります。
ブックマーク管理
ユーザーが URL を保存したときに、ページメタデータを使ってブックマークライブラリを補完します。返された title、description、image は、保存済みリンクを視覚的に整理するのに使えます。
公開前のリンク検証
ソーシャル投稿の予約投稿ツールで公開前に URL の表示を確認します。API が返す画像の寸法は、想定のアスペクト比に収まらないプレビューの検出に役立ちます。
メタデータ専用のワークフロー
ページ本文全体ではなくプレビュー情報だけが必要な場合に、軽量なメタデータソースとしてレスポンスを利用します。ページの完全なコンテンツ抽出が必要な場合は Exabase Extract を使うよう製品ページで案内されています。

Pros and Cons

Pros

単一の URL からリンクカード表示に必要な主要フィールドを返します。
製品ページとドキュメントによると、JavaScript でレンダリングされたページをサポートします。
テキスト項目だけでなく、画像と favicon のメタデータも含みます。
文書化されたフィールドとエラー処理により、明確な API 契約を提供します。
URL ごとに別のリソースを作成せずに利用できます。

Cons

ドキュメントでは、いくつかの URL ではプレビューデータが利用できず、その場合エンドポイントは 404 を返すと説明されています。
ランディングページでは無料枠を超えると名目的な料金が発生すると記載されているため、無制限ではありません。
この製品はフルページ抽出ではなくリンクメタデータに特化しており、サイトでは構造化されたページ内容が必要な場合は Exabase Extract を案内しています。

FAQ

Link Preview API は何を返しますか？

URL を受け取り、title、description、image、favicon、site name、canonical URL、locale などの構造化されたリンクメタデータを返す単一リクエストの API です。ドキュメントでは、このレスポンスは同期的だと説明されています。

リクエストはどのように認証しますか？

開発者ガイドでは、X-Api-Key ヘッダーに送る Exabase API key を使って API を呼び出す例が示されています。一般ドキュメントでも、API key をクライアントサイドコードに露出させるべきではないと記載されています。

エンドポイントの形式は何ですか？

ドキュメントではエンドポイントを GET /v2/link と説明し、url クエリパラメータを使ったサンプルリクエストを示しています。ランディングページでも、JSON を返す GET リクエストとして案内されています。

Link Preview は無料で使えますか？

ランディングページでは、月 20,000 件のリンクプレビューまでは完全無料で、それを超えると 0.01 credits の名目的な料金がかかるとされています。価格ページでも Exabase に無料プランと有料利用モデルがあることは示されていますが、Link Preview ページの記載が最も明確な利用上限です。

JavaScript に依存するページにも対応しますか？

はい。ランディングページでは、API が JavaScript でレンダリングされたページを含めてページをリアルタイムに取得・解析すると説明されており、ドキュメントではレスポンスが同期的だとされています。プレビューデータが取得できない場合は 404 が返されます。

Quick Facts

カテゴリ: Developer Tool
製品タイプ: Link preview API
エンドポイント: GET /v2/link
認証: X-Api-Key 経由の API key
無料利用: ランディングページでは月 20,000 件のリンクプレビュー
出力: JSON プレビューメタデータ