コンテンツへスキップ

Capzy Data API. ソースを選びましょう。

対応サイトのエンドポイントを探し、パラメーターを送信して、JSONを受け取ります。ここでリファレンスを確認し、ダッシュボードのプレイグラウンドでリクエストを実行・確認できます。

Amazon検索の概要

ソース + アクションGET /v1/amazon/search
クエリwireless earbuds
レスポンスのフィールドorganic_results · タイトル、価格、ASIN

説明用の例

必要なソースを探す

ソースごとに、エンドポイント、必須の入力値、レスポンスの形式が異なります。連携を構築する前に、リファレンスを開いて対応範囲を確認してください。

すべてのソース (83)

最初のData APIリクエスト

このAmazonの例では、ソース固有のGETエンドポイントを使用します。HTTP 200ではソースのデータが返され、HTTP 202では保留中のステータスとjobIdが返されます。別のリクエストを送信する前に、Data APIダッシュボードの「実行履歴」ページで保留中のジョブを確認してください。

  1. Data APIキーを作成

    Data APIダッシュボードを開いて、専用のData APIキーをコピーします。プランのクレジットが先に使用され、追加の利用分は共通のCapzyアカウント残高に請求されます。

    Data APIを開く
  2. ソースとアクションを選ぶ

    サイトのリファレンスで、メソッド、パス、必須パラメーターを確認します。Amazon検索の例では、queryとdomainを /v1/amazon/search に送信します。

    Amazon検索のパラメーターを読む
  3. プレイグラウンドでJSONを確認

    ダッシュボードで対応するソースを開き、アクションを選んで入力値を入力し、リクエストを実行します。実行前に、エンドポイントの現在の料金を確認してください。

    Amazon検索のプレイグラウンドを開く
amazon_search.py
# Install: pip install requests
import os
import requests

response = requests.get(
    "https://api.capzy.ai/v1/amazon/search",
    headers={"X-API-Key": os.environ["CAPZY_DATA_API_KEY"]},
    params={"query": "wireless earbuds", "domain": "com"},
    timeout=120,
)
response.raise_for_status()
data = response.json()
if response.status_code == 202:
    print("Pending:", data.get("status"), "Job:", data.get("jobId"))
    print("Inspect this job in https://capzy.ai/dashboard/data-api/runs")
else:
    for item in data.get("organic_results", []):
        print(item["title"], item.get("price"))
    print("Credits used:", response.headers.get("X-Credits-Used"))

呼び出す前に仕様を把握する

認証はすべてのData APIソースで共通です。メソッド、パラメーター、返されるフィールドはエンドポイントごとに異なります。

X-API-Key必須 · ヘッダー
専用のData APIキーをこのヘッダーで送信します。キーはサーバー側で管理し、これらの例では CAPZY_DATA_API_KEY から読み込んでいます。
/v1/{source}/{path}エンドポイント固有 · パス
ソースのリファレンスに記載されたメソッドとパスに従ってください。たとえば、GET /v1/amazon/search はqueryとdomainをクエリパラメーターとして受け取ります。
X-Credits-Usedレスポンスヘッダー
リクエストで請求されたクレジットを確認できます。エンドポイントの料金とプランの割引は、ダッシュボードとソースのリファレンスに表示されます。
X-Next-Cursorレスポンスヘッダー · 存在する場合
一部のエンドポイントは次のページ用のカーソルを返します。各エンドポイントのページネーションのパラメーターを使用してください。すべてのソースが同じページネーションの方式を使うわけではありません。

ソースの実際のレスポンスフィールドを使う

HTTP 200のAmazon検索のレスポンスでは、トップレベルにorganic_resultsが含まれます。HTTP 202の場合は、代わりにjobIdを含むステータスのエンベロープが返されるので、ダッシュボードの「実行履歴」ページで確認してください。この短縮した成功レスポンスでは、説明用の商品データを使用しています。

response.example.json
{
  "search_information": {
    "query": "wireless earbuds"
  },
  "organic_results": [
    {
      "title": "Example wireless earbuds",
      "price": "$27.99",
      "extracted_price": 27.99,
      "asin": "EXAMPLE001"
    }
  ]
}

organic_results · タイトル、価格、ASIN

パラメーター

料金

Data APIのプランには、月ごとのクレジット枠が含まれます。追加の利用分は、共通のCapzyアカウント残高に請求されます。エンドポイントの現在のクレジット料金は、ソースのリファレンスでご確認ください。

最新の料金を読み込み中…

知っておきたいこと

プレイグラウンドはどこで開きますか?

ダッシュボード → Data API → スクレイパーで開けます。ソースのリンクをクリックするとそのソースのビルダーが開き、エンドポイントのリンクでは対応するアクションがあらかじめ選択されるため、実行前に必須の入力値を確認できます。

ソルバーのAPIキーは使えますか?

Data APIダッシュボードに表示される専用のData APIキーを使用してください。Data APIには独自のプラン設定と含まれるクレジットがあり、追加の利用分は共通のCapzyアカウント残高から支払われます。

すべてのソースが同じJSONを返しますか?

いいえ。各エンドポイントには、ソース固有のレスポンスの形式があります。ドキュメントに記載されたレスポンスを確認し、欠落したフィールドや任意のフィールドはアプリケーション側で処理してください。

エンドポイントが「近日公開」の場合は?

ダッシュボードでは、検証されていないエンドポイントや実行できないエンドポイントに印が付いています。そこに表示される対応アクションを使用してください。リファレンスに掲載されていても、エンドポイントの準備が整っていることを保証するものではありません。

ソースを探して、実際のリクエストを試しましょう。

ダッシュボードのプレイグラウンドで、入力値、レスポンス、現在の料金をまとめて確認できます。

プレイグラウンドを開く