10. 制限事項¶
Senju Service Managerで提供するAPI連携機能について制限事項を以下に示します。
-
APIサーバーをSSMWEBサーバーと別筐体に構築することはできません。
別筐体に構築した場合、Senju Service ManagerのAPIを実行すると500 Internal Server Errorのレスポンスが返却されます。
-
認証方式がSSM基本認証以外のユーザーはSenju Service ManagerのAPIを発行することはできません。
-
ユーザーが複数のアクセストークンを発行することはできません。
以下のAPIが実行された場合、API実行前のアクセストークンは取り消され使用できなくなります。
-
アクセストークン・リフレッシュトークンの発行
-
アクセストークンの更新
-
-
Senju Service Managerのパスワード期限切れ時、アクセストークン・リフレッシュトークンの発行APIのレスポンスは、制御情報の設定値に従います。
-
サービスデスクユーザーの場合
管理項目名 選択値 アクセストークン・リフレッシュトークンの発行 パスワード期限切れ時の動作(サービスデスクユーザー) 変更しない(ログインする) ○:発行する 変更しない(ログインしない) ×:発行しない 変更する ×:発行しない -
エンドユーザーの場合
管理項目名 選択値 アクセストークン・リフレッシュトークンの発行 パスワード期限切れ時の動作(エンドユーザー) 変更しない(ログインする) ○:発行する 変更しない(ログインしない) ×:発行しない 変更する ×:発行しない
仕様補足
APIは画面を持たないため、Senju Service Manager画面のように強制的にパスワードを変更させ変更後のパスワードでログインするのと同等の処理が行えません。
そのため、管理項目の選択値が「変更する」の場合は認証失敗とみなしアクセストークン・リフレッシュトークンを発行しません。
上記の場合、Senju Service Manager画面からパスワード変更を行ってください。 -
-
APIサーバーとSSMWEBサーバーで使用しているWEBサーバーが異なるため、Senju Service Manager画面とSenju Service ManagerのAPIで制御情報の設定値が反映されるタイミングが異なります。
-
SSL通信を行う場合、SSM WEBサーバーには認証局から発行された証明書を利用してください。認証局から発行されていない証明書を利用した場合、Senju Service ManagerのAPIを実行すると500 Internal Server Errorのレスポンスが返却されます。
-
APIのリクエストボディにShift-JIS範囲外の文字を入力すると、HTMLエンコードされた状態に変換されます。また、Windows-31J (MS932)範囲内の文字(髙﨑纊①㈱㌔...)もエンコードされてしまいます。
-
リッチテキスト項目には 1000 万バイトまで入力することが可能ですが、この上限値は指定された情報をエスケープ処理した後のサイズとなります。記号等を含む場合には余裕を持って指定してください。指定したファイルのサイズが上限を超えた場合、該当項目は登録及び更新されません。
-
リッチテキスト項目に値を入れてAPIを実行すると、レスポンスには特定のHTMLタグ情報が付与されます。
-
リッチテキスト項目を入力する場合、制御情報「イベント連携のリッチテキスト項目の入力チェック設定」の設定値について以下の仕様になります。
- 「チェックしない」を指定した場合、許可しないタグが含まれていると該当のタグをサニタイズして処理を継続します。
- 「チェックする」を指定した場合、許可しないタグが含まれていると500エラーとなります。
-
APIでリッチテキスト項目値の先頭に空白を入力して実行した場合、先頭の空白は削除されずにそのまま入力されます。
-
リッチテキスト項目に設定した値の中にShift_JISで表示できない(機種依存)文字が含まれる場合、入力形式がHTML形式の場合、画面表示時には正常に入力した文字形式で表示されます。ただし、入力形式がテキスト形式の場合、画面上からデコードされた文字が表示されることがあります。