REST API

ジョブ

バックグラウンド処理をポーリングし、すべての結果ページを取得します。

GET https://www.ninjabuy.com/api/v1/jobs/{id}には同じアカウントのBearerトークンが必要です。ジョブが存在しない、不明、または別のアカウントに属する場合は404を返します。

ライフサイクル

job.status意味
queued開始を待っています。
running処理中です。結果が追加される場合があります。
done処理が完了しました。各結果のステータスを確認してください。
failedジョブが失敗しました。job.errorがある場合は確認してください。

jobにはid、kind、status、startedAtと、任意のprogress(done、total)、finishedAt、result、errorが含まれます。タイムスタンプはUnixエポックからのミリ秒です。待機中または実行中は、poll_after_secondsとRetry-Afterヘッダーが待ち時間を示します。最初の推奨値は5秒です。

リンクの一括処理はkind: "link_mints"です。最終的なresultはtotal、converted、failedと、任意のcampaign、labelを返します。ここでのfailedは変換できずに応答した入力の数で、ジョブ全体のステータスがfailedであることを意味しません。シート変換はkind: "sheet_conversion"です。最終的なjob.resultには件数と署名付きXLSXダウンロードURLが含まれます。ジョブのスキーマはsheet_read、picture_copy、resolution_runにも対応しています。

カーソルによるページ取得

レスポンスにはjob、results、cursor、has_more、request_idが含まれます。1ページには入力順で最大50件の結果が含まれます。

  1. 最初のページではcursorを省略します(オフセット0)。
  2. resultsを処理し、返されたnull以外のcursorを保持します。
  3. has_moreがtrueの場合、?cursor=RETURNED_CURSORで次のページを取得します。
  4. 待機中または実行中にhas_moreがfalseの場合は、poll_after_secondsだけ待ち、保持しているカーソルでポーリングします。結果は後から追加される場合があります。
  5. ジョブがdoneまたはfailedになり、すべての結果ページを取得してから終了します(cursorがnull)。

カーソルは1〜6桁(0〜999999)の単一のクエリパラメーターである必要があります。不正または重複するカーソルパラメーターは400を返します。has_more: falseだけを完了と判断しないでください。curlの例をご覧ください。