すべての記事

一般的な 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/contactsa0コールで使用しようとした場合

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

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

400 - invalid_parameter

考えられる原因

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

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

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

400 - method_not_found

考えられる原因

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

: サポートされていない PUT/tasks コールをユーザーが送信しようとした場合。 

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

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

403 - not_allowed

考えられる原因

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

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

    : Business Plus subscription のユーザーが GET/data_exporta0メソッドを呼び出した場合。

  • アカウントにこの操作を行うための必要なライセンスがありません。
    : Collaborator がフォルダーのタイトルを更新しようとした場合。
  • この操作は実行できません。
    : ユーザーが既に存在する dependency を作成しようとした場合。

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

  • 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}/tasksa0コールを送信した場合

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

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

プロ向けヒント

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

複数の Wrike アカウントを使い分けていて、そのトークンがどのアカウントに紐付いているのか分からないですか? ご安心ください。簡単に特定できます。 確認するには、GET/account コールを実行するだけです。

トークンの所有者を特定する

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

サポートへ連絡

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

迅速な解決のために、次の情報をご提供ください。

  • API コールで達成したいこと
  • 送信した API リクエスト全文
  • 受け取ったレスポンス
  • [権限またはトークン関連の問題の場合]a0
    トークンの中央部分をお送りください。当社側でデコードできます。

    以下はアクセストークンの例です。 2 つのドットで囲まれた(太字で強調されている)部分のみを送信し、ドットの前後の部分は削除してください:

    eyJ0dCI6InAiLCJhbGciOiJIUzI1NiIsInR2IjoiMSJ9.eyJkIjoie1wiYVwiOjM5MjA2MDIsXCJpXCI6NzIyMzMxOCxcImNcIjo0NjIwNzcwLFwidVwiOjY5NzA4NjcsXCJyXCI6XCJVU1wiLFwic1wiOltcIldcIixcIkZcIixcIklcIixcIlVcIixcIktcIixcIkNcIixcIkRcIixcIk1cIixcIkFcIixcIkxcIixcIlBcIl0sXCJ6XCI6W10sXCJ0XCI6MH0iLCJpYXQiOjE1OTk5MDk0MzV9.q3qOJs2swWSCgZl1ueKYsUyhME4RBD4cl53vZ0pwDcc

    重要

    決してトークン全体を送らないでください! パーマネントトークンを共有することは、Wrike アカウントのパスワードを共有することと同じです。

トップ