POST result_download

API情報

HTTPメソッド	API名	パス	目的
POST	result_download_url	/r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/operation/result_download_url.json	オペレーション結果ダウンロード用URLの発行

APIバージョン:20190625

個別パラメータ

URL

パラメータ

必須

タイプ

説明

例

APIVersion

〇

String

APIバージョン

20190625

ServiceCode

〇

String

オペレーション結果ダウンロード用URLを発行する対象契約の親サービスコード

yemXXXXXXXX

ChildServiceCode

〇

String

オペレーション結果ダウンロード用URLを発行する対象契約の子サービスコード

yelXXXXXXXX

yeoXXXXXXXX

yexXXXXXXXX

HTTPリクエストボディ

パラメータ

必須

タイプ

説明

例

OperationId

〇

String

ダウンロード対象とするオペレーションのID(英数字6桁)
ダウンロード対象として指定可能なオペレーション種別は「勤怠簿出力」です

123456

Acl

String

ダウンロードを許可するIPアドレス (IPアドレス, IPアドレス/ネットマスク)
指定したIPアドレスからのアクセス時のみオペレーション結果がダウンロードができます

192.168.0.1

192.168.0.0/24

レスポンス

パラメータ

タイプ

説明

例

APIResult.EncryptKey

String

オペレーション結果ダウンロード用URLにアクセスする際に利用する暗号化用のキー

英数字及び以下の記号の12桁

_-%@!?^

APIResult.ResultDownloadURL

String

オペレーション結果ダウンロード用URL
オペレーション結果ダウンロード用URLの末尾はオペレーション結果ダウンロード用のユニークID
有効期限は発行してから1時間

https://api.secureep.jp/public_api/v1/operation-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

エラーコード

共通エラーコードはエラーレスポンスを参照してください。

エラー	HTTP Status Code	ErrorType	ErrorMessage	ErrorDetail.Reason	意味	備考
パラメータエラー	200	BadRequest	Specified parameter has some errors.	Required parameter 'OperationId' not found.	リクエストパラメータにOperationIdが存在しない
				Operation id [OperationId] has not finished or has no downloadable result.	以下のいずれかの場合リクエストパラメータのOperationIdのオペレーションが完了していないリクエストパラメータのOperationIdのオペレーションはダウンロード可能なオペレーション種別ではない
				Parameter 'Acl' must be IPv4 ipaddress or network address.	リクエストパラメータのAclのフォーマットエラー
存在しない	200	NotFound	Specified child service code is not contracted.	[ServiceCode] is not found under [ChildServiceCode].	指定された子サービスコードが親サービスコードの配下に存在しない
存在しない	200	NotFound	Specified operation id is not found.	No such operation id [OperationId].	リクエストパラメータのOperationIdが存在しない
システム障害	200	SystemError	System error occurred.		API設備のシステム障害	サポートセンターへお問い合わせください

制限

なし

サンプル

リクエスト

POST /r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/operation/result_download_url.json HTTP/1.1
Host: ep.api.iij.jp
x-iijapi-Expire: 2019-09-20T09:19:01Z
x-iijapi-SignatureMethod: [SignatureMethod]
x-iijapi-SignatureVersion: [SignatureVersion]
Authorization:IIJAPI [AccessKeyId]:[Signature]
Content-Type: application/json
 
{"OperationId": "xxxxxx","Acl":"xxx.xxx.xxx.xxx"}

レスポンス

  "APIResult": {

    "EncryptKey": "xxxxxxxxxxxx",

    "ResultDownloadURL": "https://api.secureep.jp/public_api/v1/operation-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",

    "RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx"

オペレーション結果ダウンロード

オペレーション結果のダウンロードを行うには本ページのresult_download_urlを利用し、オペレーション結果をダウンロードするためのURLを取得して以下の形式でAPIにアクセスしてください。

API情報

HTTPメソッド	アクセス先
GET	[取得したオペレーション結果ダウンロードURL]?MasterID=XXXXXXXXXXXXXXXXXXXXXXXX

リクエストパラメータ

パラメータ

必須

説明

例

取得したオペレーション結果ダウンロードURL

〇

result_download_url で取得したResultDownloadURLの値

https://api.secureep.jp/public_api/v1/operation-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

MasterID

〇

マスターIDをAES-128-CBCで暗号化した結果をbase64でエンコードした値

メッセージダイジェストにはMD5を利用します
saltは利用しません
passwordにはlog_download_urlで取得したEncryptKeyの値を利用します
生成した値はSignature生成時のURLエンコード方法を参考にURLエンコードを実施します

生成例

echo -n [MasterID] | openssl enc -md md5 -aes-128-cbc -e -nosalt -pass pass:[password] -base64

パラメータ

意味

例

MasterID

IIJサービスオンラインにログインするためのID

SAXXXXXXX

password

result_download_url で取得したEncryptKeyの値

英数字及び以下の記号の12桁

_-%@!?^

レスポンス

指定したOperationIdのオペレーション結果をcsv形式でダウンロードできます

エラーコード

エラー	HTTP Status Code	ErrorType	ErrorMessage	意味	備考
クエリパラメータ不正	400	BadRequest	There are invalid parameters.	以下のいずれかの場合クエリパラメータが存在しない不正なクエリパラメータが含まれている
認証エラー	403	PermissionDenied	Access denied to specified operation result.	以下のいずれかの場合許可されていないIPアドレスからのアクセス URLの有効期限切れ MasterIDが正しくない
パラメータエラー	404	NotFound	Operation download request not found.	オペレーション結果ダウンロード用IDが正しくない
URL不正	404	NotFound	URL is not valid.	以下のいずれかの場合アクセスURLが正しくない存在しないAPIが指定された
システム障害	500	SystemError	System error occurred.	API設備のシステム障害	IIJサポートセンターへお問い合わせください

公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ