トラブルシューティング

発生したエラーの原因がつかめない場合、レスポンスに含まれるエラーメッセージや、開発者ログ の内容を確認するとともに、一般的な確認事項として、以下の点もご確認ください。

  1. サーバー設置場所は合っていますか?

    サーバーの URL がアプリのサーバー設置場所と一致していることを確認してください。一致しない場合、HTTP のステータスコードが「404 Not Found」、レスポンスの errorCodeAPP_NOT_FOUND で返ります。

    アプリのサーバー設置場所が「Japan」以外の場合、本ガイドの URL を書き換える必要があります。アプリごとのサーバー設置場所は、開発者ポータルの起動直後に表示されるアプリ一覧画面で、「Server Location」として表示されます。

    なお、日本語版のリファレンスガイドは「Japan」用の https://api-jp.kii.com/、英語版は「United States」用の https://api.kii.com、中国語版は「China」用の https://api-cn3.kii.com/ として記述しています。

  2. HTTP のメソッドは一致していますか?

    HTTP のメソッドが API で指定されているものと一致しないと、原因の特定が難しいエラー情報を返すことがあります。

    REST API は使用する機能によって GET、POST、PUT、DELETE などのメソッドが決まっています。メソッドが異なると、正しく動作しない場合や別の機能として動作する場合があります。

    指定された URL に対してメソッドが定義されていない場合は、HTTP のステータスコードが「405 Method Not Allowed」となって、すぐに原因を認識できます。しかし、そのメソッドに別の機能が割り当てられていた場合には、原因が特定しにくいエラーを返すことがあります。たとえば、誤ったメソッドでアクセスした API が偶然存在し、かつ、その API が特定の Content-Type しかサポートしない場合には、「415 Unsupported Media Type」など、メソッドの誤りとは異なるエラーが返ります。サンプルコードや詳細ドキュメントのメソッドと一致していることを常にご確認ください。

    また、メソッド名がすべて大文字である点もご確認ください。

  3. プログラムから呼び出す場合、パラメータは JSON で送信されていますか?

    POST メソッドや PUT メソッドのパラメータをプログラムから送信する場合、パラメータの送信方法が正しいことをご確認ください。特に、HTTP のステータスコードが「400 Bad Request」、レスポンスの errorCodeINVALID_JSON の場合は、整形方法に問題がある可能性があります。

    たとえば、JavaScript から REST API を使う場合、Server Code のサンプル に示すように、jQuery を使うことができます。リンク先ページに示すように、パラメータを JSON.stringify() によって整形しないと、JSON 文字列として整形されないため、上記のエラーになります。

    JavaScript 以外の言語から呼び出す場合も、同様の点にご注意ください。