概要

内容

API仕様の変更

以下に示しています「API V2 仕様書」をご参考に、ご利用環境に応じて設定をお願い致します。 

API V2 仕様書は以下のリンクから確認することが可能です。
https://api.freshservice.com/

参考：API V1 仕様書は以下のリンクから確認することが可能です。
https://api.freshservice.com/v1/

API V2の主要な変更点

1. プラン種別に応じたAPI呼び出し数
   APIの安定性と拡張性を向上させるため、時間単位から分単位のレート制限へ移行しています。

   アクション	呼び出し数／分
   	Free	Growth	Pro	Enterprise
   全体	100	200	400	500
   Sub Limits
   全てのチケットの 呼び出し	40	70	120	140
   チケットの閲覧	50	80	140	160
   チケットの作成	50	80	140	160
   チケットの更新	50	80	140	160
   全てのアセットの 呼び出し	40	70	120	140
   アセットの更新	50	80	140	160
   全てのエージェント呼び出し	40	70	120	140
   全てのリクエスタ 呼び出し	40	70	120	140

   
   
   

2. エラー対応の改善
   エラーを特例するためのHTTPステータスコードを使用して、エラーのあるAPIリクエストを迅速かつ正確に修正します。
   APIリクエストの結果がエラーの場合、HTTPステータスコードからエラー種別を判別することができます。
   
   【HTTPステータスコード一覧】

   HTTP ステータスコード	テキスト	詳細
   400	Client or Validation Error	リクエストボディ／クエリの文字列が正しい形式ではありません。例えば、Create a ticket APIの場合、requester_id　フィールドを送信する必要がありますが、不備がある場合にこのステータスコードが返されます。
   401	Authentication Failure	認証ヘッダーがない、または、不正確な場合にこのステータスコードが返されます。認証ヘッダーの詳細については、こちらをご覧ください。
   403	Access Denied	リクエストをおこなったエージェントが、APIの呼び出しを実行する権限を与えられていないことでこのステータスコードが返されます。以下の要因が考えられます。 ・このAPIコールは管理者レベルの認証情報を必要とする ・Freshserviceポータルで対応する機能が有効ではない ・ユーザーがログイン失敗回数の上限を達している ・アカウントがエージェント数の上限に達している
   404	Requested Resource not Found	リクエストに無効なID/Freshserviceドメインが含まれている場合、またはURL自体が無効な場合に、このステータスコードが返されます。例えば、無効なIDを持つチケットを取得するAPIコール等。
   405	Method not allowed	間違ったHTTP/メソッドを使用した場合に、このステータスコードが返されます。例えば、/api/v2/tickets エンドポイントへのAPI PUT リクエストは /api/v2/tickets は GET と POST リクエストのみを許可しているため、エラーとなります。
   406	Unsupported Accept Header	application/jsonと*/*のみ対応しています。 ファイルアップロード時はmultipart/form-dataをサポートします。
   409	Inconsistent/Conflicting State	作成/更新されるリソースが不整合または競合する場合に、このステータスコードが返されます。
   415	Unsupported Content-type	コンテンツタイプはapplication/xmlには対応していません。application/json のみサポートされます。
   429	Rate Limit Exceeded	Freshserviceドメインに割り当てられているAPIレートの上限に達した場合に、このステータスコードが返されます。
   500	Unexpected Server Error	Freshservice側でのエラーを表しています。こちらのエラーを検出された場合、弊社サポートセンター（fw-support@orangeone.jp）までお問合せください。

   
   エラーレスポンス
   HTTPステータスコードに加え、デバッグに必要な情報が表示されることがあります。
   以下は、エラーレスポンスのサンプルです。
   
   

   フィールド	詳細
   field	リクエストフィールドにより発生したエラーです。HTTP 400の場合にのみ該当します。
   message	メッセージによる詳細エラーです。
   code	機械的に解析可能なカスタムコードエラーです。

   
   
   

3. 新規APIの追加
   チケットに関する新たなAPIの追加

   • チケット返信

   • チケット詳細の更新

   • チケットノートの更新

   • 最近更新されたチケットリストの取得

4. JSON(Javascript Object Notation)のみサポート

5. SSL呼び出し(HTTPS)のみサポート

6. Freshserviceドメインのみサポート　※カスタムCNAMEを除く

7. ページサイズを100まで指定可能