IIJセキュアエンドポイントサービス APIリファレンス

POST result_download_url

API情報

HTTPメソッドAPI名パス目的
POSTresult_download_url/r/[APIVersion]/[ServiceCode]/[ChildServiceCode]/operation/result_download_url.json

オペレーション結果ダウンロード用URLの発行

APIバージョン:20190625

個別パラメータ
URL
パラメータ必須タイプ説明例
APIVersion〇StringAPIバージョン20190625
ServiceCode〇Stringオペレーション結果ダウンロード用URLを発行する対象契約の親サービスコードyemXXXXXXXX
ChildServiceCode〇Stringオペレーション結果ダウンロード用URLを発行する対象契約の子サービスコード

yesXXXXXXXX

yecXXXXXXXX

yelXXXXXXXX

HTTPリクエストボディ
パラメータ必須タイプ説明例
OperationId〇String

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

123456
Acl String

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

192.168.0.1

192.168.0.0/24

レスポンス
パラメータタイプ説明例
APIResult.EncryptKeyStringオペレーション結果ダウンロード用URLにアクセスする際に利用する暗号化用のキー

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

  •  _-%@!?^
APIResult.ResultDownloadURLString

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

https://api.secureep.jp/public_api/v1/operation-download/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
エラーコード
エラーHTTP Status CodeErrorTypeErrorMessageErrorDetail.Reason意味備考
パラメータエラー200BadRequestSpecified 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のフォーマットエラー 
存在しない200NotFoundSpecified child service code is not contracted.[ServiceCode] is not found under [ChildServiceCode].

指定された子サービスコードが親サービスコードの配下に存在しない

 
Specified operation id is not found.No such operation id [OperationId].リクエストパラメータのOperationIdが存在しない 
システム障害200SystemErrorSystem 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
パラメータ意味例
MasterIDIIJサービスオンラインにログインするためのIDSAXXXXXXX
passwordresult_download_url で取得したEncryptKeyの値

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

  •  _-%@!?^
レスポンス
  • 指定したOperationIdのオペレーション結果をcsv形式でダウンロードできます
エラーコード
エラーHTTP Status CodeErrorTypeErrorMessageErrorDetail.Reason意味備考
クエリパラメータ不正400BadRequestThere are invalid parameters. 
以下のいずれかの場合
  • クエリパラメータが存在しない
  • 不正なクエリパラメータが含まれている
 
認証エラー403PermissionDeniedAccess denied to specified operation result. 

以下のいずれかの場合

  • 許可されていないIPアドレスからのアクセス
  • URLの有効期限切れ
  • MasterIDが正しくない
 
パラメータエラー404NotFoundOperation download request not found. 

オペレーション結果ダウンロード用IDが正しくない

 
URL不正URL is not valid. 

以下のいずれかの場合

  • アクセスURLが正しくない
  • 存在しないAPIが指定された
 
システム障害500SystemErrorSystem error occurred. 

API設備のシステム障害

IIJサポートセンターへお問い合わせください