REST API

検索

商品を検索したり、貼り付けたマーケットプレイスのリンクを解決したりします。

GET /api/v1/searchにはBearerトークンが必要です。顧客履歴や訪問履歴を書き込まず、Webサイトとアプリと同じ検索判定を使用します。

curl --get https://www.ninjabuy.com/api/v1/search \
  -H "Authorization: Bearer $NINJABUY_ACCESS_TOKEN" \
  --data-urlencode "q=hoodie" \
  --data-urlencode "provider=taobao" \
  --data-urlencode "page=0"

クエリパラメーター

パラメータールール
q必須。前後の空白を除去します。キーワードは2〜120文字、貼り付けたリンクは最大2,048文字です。
providertaobao（デフォルト）またはa1688。
page0から始まる0〜20の整数。デフォルトは0です。

各パラメーターは1回だけ送ってください。無効なパラメーターや重複したパラメーターは、bad-body問題付きの400を返します。

応答の種類

すべての成功した応答にkindとrequest_idが含まれます。

kindフィールドと意味
productsキーワードの検索結果。items、page、pageSize、totalCount、maximumPageCount、unread（読み取れなかった貼り付け内容のhostオブジェクト、それ以外はnull）を含みます。
product1つの商品。handleとWebサイトのurlを含みます。貼り付けたリンクや商品ID検索は、この種類に直接解決される場合があります。
vendor解決されたショップ。vendorを含みます。
sheet認識されたGoogle Sheet。sheetIdとnullになり得るgidを含み、シートの内容は含みません。
unsupported認識された非対応リンク。marketplaceとidを含むlinkを返します。

productsの各項目には、handle、Webサイトのurl、title、price: { amount, currency: "CNY" }、nullになり得るimage、marketplace（taobaoまたはa1688）が含まれます。amountはWebサイトの商品グリッドと同じ中国人民元の小数文字列です。検索結果のURLは通常の商品URLです。紹介実績が記録されるリンクの作成にはリンクを使用してください。

消費とレート制限

貼り付けたリンクには匿名リゾルバーを使用し、有料のBright Dataブロック解除サービスを購入することはありません。認識された商品、ショップ、シート、非対応リンクはキーワード検索をスキップします。読み取れなかった貼り付け内容はキーワード検索に進み、OT検索枠を消費する場合があります。

キーワード検索には、リンク作成の呼び出しとは別に、アカウントごとに60秒あたり30回の独立した制限があります。キーワード検索の受け付け判定まで進んだ成功レスポンスと、検索レート制限による拒否レスポンスには、次のヘッダーが含まれます。

RateLimit-Policy: "search";q=30;w=60
RateLimit: "search";r=29;t=60

拒否された場合、429、search-rate-limited問題、秒数のRetry-Afterを返します。解決された貼り付け内容はどちらの枠も消費せず、検索レート制限ヘッダーも付きません。すべてのレスポンスにX-Request-IdとCache-Control: no-storeが含まれます。各ヘッダーフィールドについてはレート制限をご覧ください。

リンク

リクエストフィールド、リンクごとの結果、再リクエストについて。

シート

Google Sheets、XLSX、CSVを紹介実績が記録されるXLSXブックに変換します。

このページの内容

クエリパラメーター応答の種類消費とレート制限