2021/04/30

MANUAL

FAQ:API使用時の注意点やエラーが発生する場合の確認事項

## URL 指定するURLは環境により異なります。 以下の例は、それぞれの環境でitems情報を取得する際のURL例です。 ### クラウド - Pleasanter.netでの使用 https://pleasanter.net/fs/api/items/999/get ### クラウド - デモ環境での使用 https://pleasanter.azurewebsites.net/api/items/999/get ### オンプレミス - .NET Framework での使用 http://192.168.1.100/pleasanter/api/items/999/get ※192.168.1.100 の部分はサーバのIPアドレス等に置き換えてください。 ### オンプレミス - .NET Core での使用 http://192.168.1.100/api/items/999/get ※192.168.1.100 の部分はサーバのIPアドレス等に置き換えてください。 オンプレミス環境の場合、プリザンターを配置したパスによりURLが異なります。 上記は、ユーザーマニュアルに沿ってインストールした場合のURLとなりますので、上記URLで動作を保証するものではございません。正しく動作しない場合は、システム管理者にお問い合わせください。 以下のようなエラーが表示される場合は、サーバアドレス以降の部分(/pleasanter/ の有無など配置パス)が正しくない可能性があります。 ``` The resource you are looking for has been removed, had its name changed, or is temporarily unavailable. ``` ``` HTTP Error 404.0 - Not Found 探しているリソースは削除されたか、名前が変更されたか、または一時的に使用不可能になっています。 ``` ※エラーメッセージはサーバにより異なります。 ## HTTPメソッド プリザンターのAPIはHTTPメソッドにPOSTを使用します。 以下のようなエラーが表示される場合は、HTTPメソッドが異なる可能性があります。 ``` 403 Forbidden ``` ``` "Message": "要求されたリソースは、http メソッド 'GET' をサポートしていません。" ``` ※エラーメッセージはサーバにより異なります。 ## リクエスト プリザンターのAPIはJSON形式での記述となります。 構文が誤っている場合、正しいリクエストとして認識されず以下のようなエラーが表示されます。 ``` {"Id":0,"StatusCode":401,"Message":"認証できませんでした。"} ``` 上記のエラーが発生する場合、 ・JSON構文が正しくない ・APIキーが正しくない どちらかの可能性が高いので確認してください。 JSON構文については「JSON構文チェッカー」などのサービスをご利用ください。
このページをシェアする