SOAP 専用 API
本ページでは、SOAP APIでのみ使用可能なメソッド名を示します。
JSON APIでは、代替手段を取ってください。
ログイン関連API
JSON APIでは、トークン認証を利用してください。
loginSession()
概要
ログインして、セッションを開始します。
要ログイン
不要です。
必要オプション
ありません。
必要権限
ありません。
引数
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
username | string | ログイン名 | admin@example.com |
password | string | パスワード | password |
返値
ありません。
動作
usernameで指定されたユーザ名、passwordで指定されたパスワードで、ログインを試みます。
SOAP例外
| 例外コード | 例外説明 | 状況 |
|---|---|---|
KR_API_F0100 | Already Logined. | ログイン状態で再度ログインをしようとしました。 |
KR_API_F0101 | Login Failed. | ログインに失敗しました。 |
KR_API_F0105 | Account Is Disabled. | アカウントの状態が無効に設定されています。 |
KR_API_F0022 | Session 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()
概要
ログイン可能なユーザのログイン名・パスワードの整合性を確認します。
要ログイン
不要です。
必要オプション
ありません。
必要権限
ありません。
引数
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
username | string | ログイン名 | admin@example.com |
password | string | パスワード | Password |
返値
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
result | bool | true: 確認成功 false: 確認失敗（ログイン名とパスワードの組み合わせが正しくない） | true |
動作
usernameで指定されたユーザ名、passwordで指定されたパスワードで、ログイン可能なアカウントか判定します。
SOAP例外
API固有のSOAP例外はありません。
監査ログ
記録されません。
備考
このAPIでは、ユーザの有効無効状態、アカウントロック状態、アカウント毎のAPIのIPアドレス制限は考慮されていないので注意してください。
ファイルアップロードAPI
JSON APIでは、 /api/v1/upload_stored_files を利用してください。
getUploadUrl()
概要
httpsによるファイル転送先URLを取得します。
要ログイン
必要です。
必要オプション
ありません。
必要権限
ありません。
引数
| 引数名 | 型 | デフォルト値 | 値 | 例 |
|---|---|---|---|---|
character_code | string | utf8 | 転送ファイル文字コード | sjis |
line_feed_code | string | lf (Line Feed) | 転送ファイル改行種別 | crlf |
返値
| 返値名 | 型 | 値 | 例 |
|---|---|---|---|
url | string | ファイル転送先URL | https://krs.bz/環境ID/request_url?v=12345 |
動作
https によるファイル転送先URLを発行します。
SOAP例外
| 例外コード | 例外説明 | 状況 |
|---|---|---|
KR_API_F0202 | URL 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によるファイル転送状況を取得します。
要ログイン
必要です。
必要オプション
ありません。
必要権限
全てのアクセス権および操作のみです。
引数
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
url | string | ファイル転送先URL | https://krs.bz/環境ID/request_url?v=12345 |
ファイル転送先URLは、getUploadUrl()によって取得したものを指定します。
返値
| 返値名 | 型 | 値 | 例 |
|---|---|---|---|
result | integer | ファイル転送状況 | 1 |
転送状況の値は以下の通りです。
| 値 | 内容 |
|---|---|
| 0 | ファイルアップロードが行われていません。 |
| 1 | ファイルアップロード完了（正常） |
| 2 | 要求されたURLは存在しません。 |
| 3 | 指定のファイルサイズ（最大52428800バイト）を超過しています。 |
| 4 | ファイル転送は完全に終了しませんでした。 |
| 5 | ファイルは転送されませんでした。 |
| 6 | ファイルアップロードは異常終了しました。 |
| 7 | ファイル転送有効時間内ではありません。 |
| 8 | ファイルの文字、改行コードが認識できません。 |
| 9 | ファイルがウィルスに感染している、あるいは、ウイルススキャンに失敗しました。 |
| 99 | 対象ファイルはすでに会員データベースへのインポートを完了しています。 |
動作
httpsによるファイル転送状況を取得します。
SOAP例外
ありません。
監査ログ
記録されません。
備考
このAPIを再度発行するときは、30秒以上の間隔をあけなければなりません。サーバ側においても、連続呼び出し対応のためウェイトを設けています。
getStoredFileID()
概要
KREISELに格納された転送ファイルデータの内部格納IDを取得します。
要ログイン
必要です。
必要オプション
ありません。
必要権限
ありません。
引数
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
url | string | ファイル転送先URL | https://krs.bz/環境ID/request_url?v=12345 |
ファイル転送先URLは、getUploadUrl()によって取得したものを指定します。
返値
| 返値名 | 型 | 値 | 例 |
|---|---|---|---|
stored_file_id | integer | 転送ファイルデータの内部格納ID | 185 |
動作
会員データベースへ転送ファイルデータをインポートする際に指定する、内部格納ファイルIDを取得します。
SOAP例外
| 例外コード | 例外説明 | 状況 |
|---|---|---|
KR_API_F0200 | Access Denied. | 要求されたURLは存在しません。 |
KR_API_F0201 | Forwarding Or Terminating. | ファイルは転送中か、異常終了しました。 |
監査ログ
記録されません。
備考
ありません。
一括処理関連API
JSON APIでは、 /api/v1/get_batch_job_result を利用してください。
getBatchJobResultUrl()
概要
一括処理の結果をダウンロードするためのURLを取得します。
要ログイン
必要です。
必要オプション
ありません。
必要権限
ありません。
引数
| 引数名 | 型 | 値 | 例 |
|---|---|---|---|
batch_job_id | integer | 一括処理ID | 10 |
返値
| 返値名 | 型 | 値 | 例 |
|---|---|---|---|
url | string | ダウンロード用URL | https://krs.bz/環境ID/download_url?xx |
動作
一括処理の結果をダウンロードするためのURLを取得します。
対象となる一括処理は以下の通りです。
exportMembers()importMembers()
SOAP例外
| 例外コード | 例外説明 | 状況 |
|---|---|---|
KR_API_F0305 | Batch Job Is Running. | 一括処理はまだ実行中です。 |
KR_API_F0306 | No Result File. | この一括処理にはダウンロードできる、結果が存在しません。 |
KR_API_F0307 | No Has Privilage To Download Result File. | 結果ファイルをダウンロードする権限がありません。 |
監査ログ
記録されません。
備考
- このAPIによって得られたURLに対して、通常のHTTPリクエストを行うことで、結果をダウンロードできます。
- 結果の保存期間は7日間であり、管理画面から一括処理を行った場合の保存期間に準じます。
- 保存期間を経過していた場合は、Not Found（ステータス: 404）となります。