すべての記事

一般的な REST API エラーの解決方法

Situation

Wrike API を使用する際、エラーは避けられません。 これらは、ユーザー権限の不足、アカウントライセンス制限、不正なフォーマットなど、さまざまな理由で発生する可能性があります。 本記事では、よく発生する API エラーを取り上げ、素早く原因を特定して解決できるようトラブルシューティング手順を紹介します。

重要

必ず API ドキュメント を再確認してください。

エラー応答

以下は、API リクエストが失敗した場合によく返されるエラー応答の例です。

ステータスコード: XXX
レスポンスボディ:

{
"errorDescription": "human-readable description of the error.",
"error": "short, standardized code or identifier for the specific error that occurred"
}

ステータスコード

300 - Multiple Choices

考えられる原因

Base URL が正しくありません。

トラブルシューティング手順

Base URL が正しいことを確認してください。
Wrike は、米国および欧州連合にある複数のデータセンターに顧客データを保存しています。 データへアクセスする際は、データが保存されている場所に対応した Base URL を使用してください。 ブラウザで Wrike アカウントにアクセスした際、アドレスバーに表示される URL から Base URL を確認できます。

400 - invalid_request

考えられる原因

  • HTTタイプのリクエストは無効です、クリティカルデータのリクエストが存在しないか、不正な形式です（例：添付ファイルの本文がない）。
  • ヘッダーがありません。
  • リクエストパラメータ名が無効です。
  • このエンドポイントではリクエストパラメータがサポートされていません。

例: ユーザーが 'firstName' パラメータを GET/contacts 呼び出しで使用しようとした場合

トラブルシューティング手順

  • API ドキュメントを確認し、リクエストの形式が正しいことを確認してください。すべてのパラメータが有効で、エンドポイントでサポートされている必要があります。
  • リクエストに必要なすべてのヘッダーが含まれていることを確認してください。

400 - invalid_parameter

考えられる原因

  • 必須パラメータがありません。
  • パラメータ値が不適切またはフォーマットが誤っています。

トラブルシューティング手順

  • ドキュメントを再確認し、必須と記載されているすべてのパラメータが呼び出しに含まれていることを確認してください。
  • パラメータの値が正しく、ドキュメントに記載された形式になっていることを確認してください。

400 - method_not_found

考えられる原因

不正な API メソッドが使用されています。

例: ユーザーがサポートされていない PUT/tasks 呼び出しを送信しようとした場合 

トラブルシューティング手順

使用するメソッドがエンドポイントでサポートされており、正しく設定されていることを確認してください。

403 - not_allowed

考えられる原因

ライセンス/クォータ制限などにより、要求された操作は許可されていません。

  • ユーザーに要求された操作を実行する権限がありません。

    例: Business Plus サブスクリプション のユーザーが GET/data_export メソッドを呼び出した場合。

  • アカウントに操作を実行するためのライセンスがありません。
    例: Collaborator がフォルダーのタイトルを更新しようとする場合。

  • 操作を実行できません。
    例: ユーザーが既に存在する 依存関係 を作成しようとした場合。

トラブルシューティング手順

  • Wrike アカウント設定でユーザーの権限を確認してください。 ユーザーが要求されたリソースにアクセスするための権限を持っていることを確認してください。
  • アカウントのライセンスを確認してください。 この API メソッドを使用するには、ライセンスのアップグレードが必要になる場合があります。
  • ユーザーが UI で同じ操作を実行できるか確認してください。

404 - resource_not_found

考えられる原因

  • 要求されたリソースは存在しません。
  • ユーザーが要求されたリソースにアクセスできません。

トラブルシューティング手順

要求されたリソースを確認し、統合で使用しているトークンのユーザーがそのリソースにアクセスできることを確認してください。

429 - too_many_requests

考えられる原因

同一 IP アドレスからのリクエスト数 (5000/分) またはユーザーごとのリクエスト数 (400/分) が上限を超えました。 最初の 1 分間の 400 件のリクエストは処理され、それを超えるリクエストにはステータス 429 が返されます。

トラブルシューティング手順

  • 429 の HTTP 応答が返された場合は、指数バックオフを用いたリトライを検討してください。
  • 複数のユーザーに負荷を分散させてください。
  • 問題が解決しない場合は、サポートチームにお問い合わせください

429 - rate_limit_exceeded

考えられる原因

レート制限を超過しました

トラブルシューティング手順

サポートチームにお問い合わせください

500 - server_error

考えられる原因

  • サーバーで予期しない状態が発生し、リクエストを処理できませんでした。
  • ユーザーが要求されたリソースにアクセスできません。

トラブルシューティング手順

空のレスポンス

考えられる原因

存在しないリソースを取得しようとしています。

例: ユーザーが空のフォルダーからタスクを取得するために GET/folders/{folderId}/tasks 呼び出しを送信する場合

トラブルシューティング手順

リソース（例： タスク/フォルダー/プロジェクトなど）がアカウントに存在することを確認してください。

プロ向けヒント

トークンが属するアカウントの特定

複数の Wrike アカウントを使い分けていて、トークンがどのアカウントに紐づいているか分からない場合は？ ご安心ください、簡単に特定できます。 GET/account 呼び出しを実行するだけで確認できます。

トークンの所有者を追跡する

複数のユーザーで API をテストしており、特定のトークンの所有者を確認したい場合には、簡単かつ直接的な方法があります。 GET/contacts?me=true 呼び出しを送信してユーザーのプロファイル情報を取得します。

サポートへ連絡

問題が解決しない場合は、サポートチームまでお問い合わせください。喜んでサポートいたします。

解決を迅速に行うために、以下の情報をご提供ください。

  • API コールの目的
  • 送信した API リクエスト全文
  • 受け取ったレスポンス
  • [権限またはトークン関連の問題の場合]
    トークンの中央部分（弊社側でデコードできるようにするため）

    以下はアクセストークンの例です。 2 つのドットに挟まれた部分（太字で表示）だけをお送りいただき、ドットの前後は省略してください: 
    eyJ0dCI6InAiLCJhbGciOiJIUzI1NiIsInR2IjoiMSJ9.eyJkIjoie1wiYVwiOjM5MjA2MDIsXCJpXCI6NzIyMzMxOCxcImNcIjo0NjIwNzcwLFwidVwiOjY5NzA4NjcsXCJyXCI6XCJVU1wiLFwic1wiOltcIldcIixcIkZcIixcIklcIixcIlVcIixcIktcIixcIkNcIixcIkRcIixcIk1cIixcIkFcIixcIkxcIixcIlBcIl0sXCJ6XCI6W10sXCJ0XCI6MH0iLCJpYXQiOjE1OTk5MDk0MzV9.q3qOJs2swWSCgZl1ueKYsUyhME4RBD4cl53vZ0pwDcc

    重要

    トークン全体を絶対に送らないでください！ 永続トークンを共有することは、Wrike アカウントのパスワードを共有するのと同じです。

トップ

関連記事