付録C.1　接続設定ファイル

(a)　URL=接続先URL

接続先のURLを，2,083バイト以内の文字列で指定します。URLは，「http://」または「https://」で始まる必要があります。シングルバイト文字で指定する必要があります。

接続先URLに，URLパラメーターを含めた指定はできません。接続先URLにURLパラメーターを含めたい場合は，URLパラメーターを送信情報ファイルに指定してください。

規定のポート番号以外を使用する場合は，URLに含めた形式で記載が必要です。規定のポート番号を次に示します。

• httpの場合：80

• httpsの場合：443

httpsの場合は「CAFile=証明書ファイル名」を指定する必要があります。

この項目は必須です。

(b)　HttpVer=HTTPバージョン

HTTPのバージョンを次のどちらかから指定します。

1.0

HTTP1.0を使用してリクエストします。

1.1

HTTP1.1を使用してリクエストします。

この項目は省略できます。省略した場合，「1.1」が仮定されます。

(c)　ConnectTimeout=接続タイムアウト時間

接続先ホストへの接続タイムアウト時間を，1〜600（単位：秒）で指定します。

ここで指定した接続タイムアウト時間内に接続先ホストと通信できない場合，HTTP接続ジョブは異常終了します。

この項目は省略できます。省略した場合，「10」が仮定されます。

注意事項

HTTP接続ジョブが実行されるホストのOSの設定，およびシステムのネットワーク設定によって，この項目で指定した値より短い時間でタイムアウトし，HTTP接続ジョブが異常終了する場合があります。OSの設定については，OSのドキュメントを参照してください。

(d)　Timeout=HTTP接続ジョブ全体の処理時間の上限

HTTP接続ジョブ全体の処理時間の上限を，1〜86,400（単位：秒）で指定します。

ここで指定した処理時間内に処理が終了しない場合，HTTP接続ジョブは異常終了します。

この項目は省略できます。省略した場合，「600」が仮定されます。

(e)　MaximumReceivedDataSize=最大受信データサイズ

Web APIから取得した受信データの最大受信データサイズを，1〜1,024（単位：メガバイト）で指定します。

指定した値は，受信したHTTPヘッダーの「Content-Length」の値と比較されます。HTTPヘッダーの「Content-Length」の方が大きい場合，データの受信を中断し，HTTP接続ジョブは異常終了します。

受信したHTTPヘッダーに「Content-Length」が指定されていない場合，データを受信しながらデータサイズをチェックします。HTTPボディのデータサイズが指定した値に達した時点でデータの受信を中断し，HTTP接続ジョブは異常終了します。

この項目は省略できます。省略した場合，「500」が仮定されます。

(f)　ClientBindAddrIP=クライアントバインドを行うIPアドレス

クライアントバインドを行う場合，バインドするIPアドレスを39バイト以内の文字列で指定します。

IPアドレスは，IPv4アドレスまたはIPv6アドレスで指定できます。

この項目は省略できます。省略した場合，クライアントバインドを行いません。

注意事項

ファイアウォール通過用に送信時のIPアドレスを特定する場合，または特定のLANだけを利用する場合は，クライアントバインドを行ってください。

(g)　Header=追加ヘッダー

リクエスト時のHTTPヘッダーに追加でヘッダーを設定する場合，追加するヘッダーを，1,024バイト以内の文字列で指定します。

追加ヘッダーは複数行指定できます。HTTP接続ジョブが設定する項目と同じ項目を設定した場合，「Header=追加ヘッダー」に指定された値が優先されます。

「Header=追加ヘッダー」の指定形式を次に示します。

Header=ヘッダー名:ヘッダー値

値を持ったカスタムヘッダーを指定する場合，ヘッダー名とヘッダー値の間に「：（コロン）」を指定します。例えば，ヘッダー名が「ABC」，ヘッダー値が「DEF」というヘッダーを指定したい場合は，「Header=ABC:DEF」と設定します。

Header=ヘッダー名:

HTTP接続ジョブが設定するヘッダーを無効にしたい場合，ヘッダー名の終端に「：（コロン）」を指定します。例えば，「ABC」というヘッダーを無効にしたい場合は，「Header=ABC:」と設定します。

Header=ヘッダー名;

値を持たないカスタムヘッダーを設定する場合，ヘッダー名の終端に「；（セミコロン）」を指定します。例えば，「ABC」という値を持たないヘッダーを指定したい場合は，「Header=ABC;」と設定します。

この項目は省略できます。省略した場合，ヘッダーを追加しません。

注意事項

HTTP接続ジョブが設定するヘッダーを無効にすると，HTTP接続ジョブが正常に実行されなくなるおそれがあります。十分に検討してから実施してください。

(h)　Authorization=WebサーバのBasic認証の有無

WebサーバでBasic認証を行うかどうかを，次のどちらかから指定します。

y

WebサーバでBasic認証を行います。

n

WebサーバでBasic認証を行いません。

「y」を指定した場合，「UserName=WebサーバのBasic認証に使用するユーザー名」と「UserPass=WebサーバのBasic認証に使用するパスワード」に指定された値を基に，リクエスト時のHTTPヘッダーにAuthorizationヘッダーを付与します。なお，「Header=追加ヘッダー」でAuthorizationヘッダーを付与している場合，「Header=追加ヘッダー」に付与された値が有効になります。

Basic認証以外の認証方式を使用する場合は，「Header=追加ヘッダー」で指定する必要があります。

接続先がWebサーバでの認証を必要としない場合に，「y」を指定したときの動作は，接続先のWebサーバの仕様に依存します。

この項目は省略できます。省略した場合，「n」が仮定されます。

(i)　UserName=WebサーバのBasic認証に使用するユーザー名

WebサーバでBasic認証を行う場合，認証に使用するユーザー名を256バイト以内の文字列で指定します。ユーザー名に「：（コロン）」は使用できません。

WebサーバでBasic認証を行う場合，この項目は必須です。

(j)　UserPass=WebサーバのBasic認証に使用するパスワード

WebサーバでBasic認証を行う場合，認証に使用するパスワードを256バイト以内の文字列で指定します。

WebサーバでBasic認証を行う場合，この項目は必須です。

(k)　Proxy=プロキシサーバ名

プロキシサーバを利用する場合，プロキシサーバ名を2,083バイト以内の文字列で指定します。

プロキシサーバでBasic認証を行う場合，この項目は必須です。

(l)　ProxyAuthorization=プロキシサーバのBasic認証の有無

プロキシサーバを利用する場合，プロキシサーバでBasic認証を行うかどうかを，次のどちらかから指定します。

y

プロキシサーバでBasic認証を行います。

n

プロキシサーバでBasic認証を行いません。

「y」を指定した場合，「ProxyUserName=プロキシサーバのBasic認証に使用するユーザー名」と「ProxyUserPass=プロキシサーバのBasic認証に使用するパスワード」に指定された値を基に，リクエスト時のHTTPヘッダーにProxyAuthorizationヘッダーを付与します。なお，「Header=追加ヘッダー」でProxyAuthorizationヘッダーを付与している場合，「Header=追加ヘッダー」に付与された値が有効になります。

Basic認証以外の認証方式を使用する場合は，「Header=追加ヘッダー」で指定する必要があります。

接続先がプロキシサーバでの認証を必要としない場合に，「y」を指定したときの動作は，接続先のプロキシサーバの仕様に依存します。

この項目は省略できます。省略した場合，「n」が仮定されます。

(m)　ProxyUserName=プロキシサーバのBasic認証に使用するユーザー名

プロキシサーバでBasic認証を行う場合，認証に使用するユーザー名を256バイト以内の文字列で指定します。ユーザー名に「：（コロン）」は使用できません。

プロキシサーバでBasic認証を行う場合，この項目は必須です。

(n)　ProxyUserPass=プロキシサーバのBasic認証に使用するパスワード

プロキシサーバでBasic認証を行う場合，認証に使用するパスワードを256バイト以内の文字列で指定します。

プロキシサーバでBasic認証を行う場合，この項目は必須です。

(o)　CAFile=証明書ファイル名

「URL=接続先URL」に「https://」で始まる文字列を指定した場合に，ルート証明書のファイル名を511バイト以内の文字列で指定します。ルート証明書はPEM形式である必要があります。DER形式を指定した場合，メッセージKAVS8062-Eが出力され，HTTP接続ジョブは異常終了します。

「URL=接続先URL」に「http://」で始まる文字列を指定した場合，この項目は省略できます。

(p)　CrlFile=証明書失効リストファイル名

サーバ証明書を検証する場合，証明書失効リストファイル名を511バイト以内の文字列で指定します。証明書失効リストファイルはPEM形式である必要があります。DER形式を指定した場合，メッセージKAVS8062-Eが出力され，HTTP接続ジョブは異常終了します。

この項目は省略できます。省略した場合，証明書の失効状況のチェックは行われません。