SFTPファイル連携の流れ

SFTPファイル連携の流れ

SFTPを用いてファイルを授受し、処理を行うサービスに共通する処理フローを整理したものです。
すべてのサービスに共通する基本ステップは以下のとおりです。

1. ファイルアップロード(加盟店様)

加盟店様は、当サービスが発行したSFTPアカウントを使用して、指定の ホームディレクトリ にファイルをアップロード(PUT)します。
接続先情報（ホスト名、ユーザIDなど）は利用の手引きをご確認ください。

アップロード時に配置するファイル（2種類）

アップロードには、以下の2つのファイルをセットで配置してください。

1. アップロードファイル（本体）

   • 所定の「アップロードファイル命名規則」に沿ったファイル名で配置します。

2. OKファイル（完了通知ファイル）

   • アップロードファイルと同名で、末尾に.okを付与したファイルです。

例：
batm000999909999920141231002.csv
batm000999909999920141231002.csv.ok

警告

ファイルには読み取り権限を付与してください。

2. ファイル取り込み(当サービス)

各サービスの処理タイミングでアップロードファイル + OKファイルのセットが揃っている場合に取り込みを行います。

3. 業務処理(当サービス)

取り込んだファイルの内容に基づき、各種業務処理を実行します。
処理結果（成功件数、エラー件数など）は記録し、返却用の結果ファイルを生成します。

4. 結果ファイルの作成・返却(当サービス)

処理完了後、アップロード元と同じディレクトリに結果ファイルを配置します。
返却時にも、以下の2種類のファイルをセットで出力します。

配置されるファイル（2種類）

1. 結果ファイル

   • アップロードされたデータファイル名の先頭に 「R」 を付与したファイル名で生成します。

   • 例：
     (アップロード) batm000999909999920141231002.csv
     (返却) Rbatm000999909999920141231002.csv

2. OKファイル（処理結果配置完了ファイル）

   • 結果ファイルと同名で.okを付与した空ファイルです。

   • 例：
     Rbatm000999909999920141231002.csv
     Rbatm000999909999920141231002.csv.ok

注記

命名規則の詳細は各サービス仕様を参照してください。

5. 返却ファイルの取得(加盟店様)

加盟店様は、返却ディレクトリに以下の手順でアクセスしてください。

1. OKファイルが存在することを確認する

   • OKファイルの存在が、返却ファイルの配置完了を示します。

2. 返却ファイルをダウンロード（GET）する

3. 返却ファイルとOKファイルをSFTPサーバーから削除する

   • 取得後の削除をお願いします。

注意事項

• 一度にアップロード可能なファイルは1ファイルとなります。
  複数ファイルがアップロードされた場合、どのファイルが処理されるか保証されません。
  一度に1ファイル(データファイルとokファイルの１ペア)をアップロードするよう、ご注意ください。
  複数回処理する場合、結果ファイルを取得後、次のファイルを配置してください。