メインコンテンツまでスキップ

SOAP 専用 API

本ページでは、SOAP API でのみ使用可能なメソッド名を示します。

JSON API では、代替手段を取ってください。

ログイン関連API​

備考

JSON API では、トークン認証を利用してください。

loginSession()​

概要​

ログインして、セッションを開始します。

要ログイン​

不要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

引数名型値例
usernamestringログイン名admin@example.com
passwordstringパスワードpassword

返値​

ありません。

動作​

usernameで指定されたユーザ名、passwordで指定されたパスワードで、ログインを試みます。

SOAP例外​

例外コード例外説明状況
KR_API_F0100Already Logined.ログイン状態で再度ログインをしようとしました。
KR_API_F0101Login Failed.ログインに失敗しました。
KR_API_F0105Account Is Disabled.アカウントの状態が無効に設定されています。
KR_API_F0022Session State Unknown.セッション状態を確認できません。

監査ログ​

記録されます。("ログイン" または "ログイン失敗"、"アカウント毎の IP アドレス制限(API)によるブロック")

備考​

セッション ID は HTTP レスポンスの中でSet-Cookie:ヘッダで指定されるので、次回以降の API 呼び出しでは Cookie に指定する必要があります。

アカウント毎の API の IP アドレス制限によって、許可されていない接続元からのアクセスについては、KR_API_F0023例外コードが返され、監査ログにはログイン失敗とアカウント毎の IP アドレス制限(API)によるブロックが記録されます。

logoutSession()​

概要​

ログアウトして、セッションを終了します。

要ログイン​

必要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

ありません。

返値​

ありません。

動作​

ログアウトします。

SOAP例外​

API 固有の SOAP 例外はありません。

監査ログ​

記録されます。("ログアウト")

備考​

HTTP レスポンスの中で Cookie を削除するためのSet-Cookie:ヘッダ(有効期限が過去のもの)が指定されるので、次回の SOAP 要求の HTTP ヘッダからはセッションのキーは送ってはなりません。(Already Finished Session SOAP 例外が返信されます)

checkLoginPassword()​

概要​

ログイン可能なユーザのログイン名・パスワードの整合性を確認します。

要ログイン​

不要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

引数名型値例
usernamestringログイン名admin@example.com
passwordstringパスワードPassword

返値​

引数名型値例
resultbooltrue: 確認成功
false: 確認失敗(ログイン名とパスワードの組み合わせが正しくない)
true

動作​

usernameで指定されたユーザ名、passwordで指定されたパスワードで、ログイン可能なアカウントか判定します。

SOAP例外​

API 固有の SOAP 例外はありません。

監査ログ​

記録されません。

備考​

この API では、ユーザの有効無効状態、アカウントロック状態、アカウント毎の API の IP アドレス制限は考慮されていないので注意してください。

ファイルアップロードAPI​

備考

JSON API では、 /api/v1/upload_stored_files を利用してください。

getUploadUrl()​

概要​

https によるファイル転送先 URL を取得します。

要ログイン​

必要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

引数名型デフォルト値値例
character_codestringutf8転送ファイル文字コードsjis
line_feed_codestringlf (Line Feed)転送ファイル改行種別crlf

返値​

返値名型値例
urlstringファイル転送先URLhttps://krs.bz/環境ID/request_url?v=12345

動作​

https によるファイル転送先 URL を発行します。

SOAP例外​

例外コード例外説明状況
KR_API_F0202URL Has Been Issued.URLはすでに発行されています。
備考

KR_API_F0202例外は、同時に複数回getUploadUrl()をコールした場合に発生します。

アップロードが終了するか、有効期限が切れるとまたgetUploadUrl()をコールできるようになります。

監査ログ​

記録されません。

備考​

この URL に対して通常の https によるファイルアップロードを行うことで、ファイルがアップロードされます。その結果は getUploadStatus() により判断します。それ以外のいかなる方法で判断してはなりません。

発行された URL には有効期限(10 分)が設けられているので、それ以内にファイルアップロードを行わなければなりません。

また、ファイルのアップロードごとに URL を新たに取得しなければなりません。

ただし、ファイルのアップロードに失敗した場合で、再度リトライを行う場合は(URL の有効期限内であれば)、同じ URL についてアップロードしなければなりません。 再度getUploadUrl()を発行するとKR_API_F0202の例外が発生します。

転送ファイルで使用可能な文字コードおよび改行種別は以下の通りです。

下記以外の文字列が指定された場合は、それぞれ utf8 , lf が指定されたものとして扱われます。また、アップロード可能なファイルサイズは最大 50MB とします。

項目内容
文字コードascii, utf8, sjis, eucjp
改行種別cr, lf, crlf

転送ファイルには有効ないずれかのテキスト形式の拡張子(txt, tsv, csv)を付与しなければなりません。

getUploadStatus()​

概要​

https によるファイル転送状況を取得します。

要ログイン​

必要です。

必要オプション​

ありません。

必要権限​

全てのアクセス権および操作のみです。

引数​

引数名型値例
urlstringファイル転送先URLhttps://krs.bz/環境ID/request_url?v=12345

ファイル転送先 URL は、getUploadUrl()によって取得したものを指定します。

返値​

返値名型値例
resultintegerファイル転送状況1

転送状況の値は以下の通りです。

値内容
0ファイルアップロードが行われていません。
1ファイルアップロード完了(正常)
2要求されたURLは存在しません。
3指定のファイルサイズ(最大52428800バイト)を超過しています。
4ファイル転送は完全に終了しませんでした。
5ファイルは転送されませんでした。
6ファイルアップロードは異常終了しました。
7ファイル転送有効時間内ではありません。
8ファイルの文字、改行コードが認識できません。
9ファイルがウィルスに感染している、あるいは、ウイルススキャンに失敗しました。
99対象ファイルはすでに会員データベースへのインポートを完了しています。

動作​

https によるファイル転送状況を取得します。

SOAP例外​

ありません。

監査ログ​

記録されません。

備考​

この API を再度発行するときは、30 秒以上の間隔をあけなければなりません。サーバ側においても、連続呼び出し対応のためウェイトを設けています。

getStoredFileID()​

概要​

KREISEL に格納された転送ファイルデータの内部格納 ID を取得します。

要ログイン​

必要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

引数名型値例
urlstringファイル転送先URLhttps://krs.bz/環境ID/request_url?v=12345

ファイル転送先 URL は、getUploadUrl()によって取得したものを指定します。

返値​

返値名型値例
stored_file_idinteger転送ファイルデータの内部格納ID185

動作​

会員データベースへ転送ファイルデータをインポートする際に指定する、内部格納ファイル ID を取得します。

SOAP例外​

例外コード例外説明状況
KR_API_F0200Access Denied.要求されたURLは存在しません。
KR_API_F0201Forwarding Or Terminating.ファイルは転送中か、異常終了しました。

監査ログ​

記録されません。

備考​

ありません。

一括処理関連API​

備考

JSON API では、 /api/v1/get_batch_job_result を利用してください。

getBatchJobResultUrl()​

概要​

一括処理の結果をダウンロードするための URL を取得します。

要ログイン​

必要です。

必要オプション​

ありません。

必要権限​

ありません。

引数​

引数名型値例
batch_job_idinteger一括処理ID10

返値​

返値名型値例
urlstringダウンロード用URLhttps://krs.bz/環境ID/download_url?xx

動作​

一括処理の結果をダウンロードするための URL を取得します。

対象となる一括処理は以下の通りです。

  • exportMembers()
  • importMembers()

SOAP例外​

例外コード例外説明状況
KR_API_F0305Batch Job Is Running.一括処理はまだ実行中です。
KR_API_F0306No Result File.この一括処理にはダウンロードできる、結果が存在しません。
KR_API_F0307No Has Privilage To Download Result File.結果ファイルをダウンロードする権限がありません。

監査ログ​

記録されません。

備考​

  • この API によって得られた URL に対して、通常の HTTP リクエストを行うことで、結果をダウンロードできます。
  • 結果の保存期間は 7 日間であり、管理画面から一括処理を行った場合の保存期間に準じます。
  • 保存期間を経過していた場合は、Not Found(ステータス: 404)となります。