OPROARTS readme

目次

OPROARTSへのリクエスト形式

下記のようなリクエスト文字列で、HTTPSでリクエストを行います。GETまたはPOSTに対応しています。リクエストを実行するフォームのサンプル

リクエストの例(PDFをダウンロードする場合)

https://[弊社からお伝えするOPROARTSのURL]?CID=XXX&UID=XXX&UPW=XXX&OP=dlp&TP=Template1&TD=CSV

後述のパラメータと共に、弊社からお伝えするOPROARTSのURLにリクエストを行なってください。

パラメータ

基本パラメータ

パラメータ意味説明備考
CID顧客ID弊社からお伝えするOPROARTSのCIDをセットしてください。※必須パラメータ
UIDユーザID弊社からお伝えするOPROARTSのUIDをセットしてください。※必須パラメータ
UPWユーザパスワード弊社からお伝えするOPROARTSのUPWをセットしてください。※必須パラメータ
OP 操作指示 下記のいずれかを指定してください。
dlo : oprドキュメントのダウンロード
dlp : pdfドキュメントのダウンロード
mlo : oprドキュメントの添付されたメールを送信(「メール送信時のパラメータ」もご覧ください)
mlp : pdfドキュメントの添付されたメールを送信(「メール送信時のパラメータ」もご覧ください)
dp : クライアントPCでの直接印刷
dlxm : Excelドキュメントのダウンロード
o.dlxm : Excelドキュメントのダウンロード(Officeアドイン利用)
o.mlxm : Excelドキュメントの添付されたメールを送信(Officeアドイン利用)(「メール送信時のパラメータ」もご覧ください)
o.dlwm : Wordドキュメントのダウンロード(Officeアドイン利用)
o.mlwm : Wordドキュメントの添付されたメールを送信(Officeアドイン利用)(「メール送信時のパラメータ」もご覧ください)
※必須パラメータ
TP テンプレート名 弊社が作成するテンプレート(帳票デザインが定義されたファイル)の名前を指定してください。
マルチテンプレート(複数のテンプレートを指定する方法)の場合は、
TP(1), TP2, TP3, ・・・, TPn : のように複数指定してください。
※ n: テンプレートのインデックス(1から始まる連番)
(例)nouhin.oxtとseikyu.oxtを使ったマルチテンプレートの例
TP1=nouhin&TP2=seikyu&TP3=nouhin&TP4=seikyu
※ マルチテンプレートをしない場合は、テンプレートインデックスを省略し、「TP」というパラメータで問題ありません。
※必須パラメータ
TD テキストデータセット 帳票に表示するテキストデータ(CSV等)の内容を指定してください。
弊社で作成するテンプレートに対応する形式(区切り文字、フィールド数等)で指定する必要があります。形式については、弊社よりお伝えいたします。
TDの値としてデータの内容を指定するか、multipart/form-data形式でファイルをアップロードすることができます。
multipart/form-data形式でアップロードする場合のファイルのエンコードは、MS932としてください。

<TDの値としてCSVの内容を指定する場合の例>
・CSVデータの内容
field1-1,field2-1,field3-1
field1-2,field2-2,field3-2
field1-3,field2-3,field3-3

・リクエスト内容
TD=field1-1%2Cfield2-1%2Cfield3-1%0D%0Afield1-2%2Cfield2-2%2Cfield3-2%0D%0Afield1-3%2Cfield2-3%2Cfield3-3
※ %2Cは、カンマ( , ) をURLエンコードした値です。
※ %0D%0Aは、改行コードをURLエンコードした値です。


複数のテキストデータセットを指定する場合は、
TD1, TD2, TD3, ・・・, TDn : のように指定してください。
※ n: テキストデータセットのインデックス(1から始まる連番)

マルチテンプレートの場合は、
TD1_1, TD1_2, TD2_1, TD2_2, TD2_3, TD3_1, ・・・, TDn_m :
のように複数指定してください。
※ n: テンプレートインデックス, m: テキストデータセットインデックス
例えば、「TD2_1」は、「TP2で指定したテンプレートの、1番目のテキストデータセット」という意味になります。

RF リフレッシュ間隔 OPROARTSから返されるHTMLの更新間隔(秒)を指定してください。
このパラメータは、主にWebブラウザのタイムアウト対策として使用します。指定すると、OPROARTS側のドキュメント生成が30秒以上かかった場合にHTMLがレスポンスされ、指定された秒数の間隔で自動更新を続けます。OPROARTS側でドキュメント(PDF等)の生成が完了した次の更新時に、ドキュメントをダウンロードすることができます。

AC ドキュメントへ添付するファイルの内容 OPROARTSが作成するドキュメントに添付するデータの内容を指定してください。
ACの値としてテキストデータの内容を指定するか、multipart/form-data形式で任意の形式のファイルをアップロードすることができます。

複数指定する場合は、AC(1), AC2, AC3,・・・・, ACn のように指定してください。
※ n: ACのインデックス(1から始まる連番)

ACN ACの内容がドキュメントに添付される際のファイル名 ACパラメータによって添付する際のファイル名を指定してください。
※省略された場合、システムで管理されているファイル名がつけられます。

ACC ACで文字列を指定された場合の、ファイルの保存時に使用する文字コード 例えば、Shift_JISを指定した場合、ドキュメントにはShift_JISのテキストデータが添付されることになります。
複数指定する場合は、ACC(1), ACC2, ACC3,・・・・, ACCn のように指定してください。
※ n: ACCのインデックス(1から始まる連番)

FEPDFへのフォントの埋め込みPDFにフォントを埋め込むは true、埋め込まない場合は false を指定してください。このパラメータを省略した場合、フォントは埋め込まれません。パラメータ「OP」の値に、「dlp」または「mlp」を指定した場合にのみ有効なパラメータです。

メール送信時のパラメータ

パラメータ「OP」の値に、「mlo」または「mlp」を指定した場合のパラメータです。

パラメータ意味説明備考
MT メール送信先 メールの送信先アドレスを指定してください。
複数の送信先を使用する場合、各メールアドレスをカンマ区切りで指定してください。
※必須パラメータ
MCC メール送信先(CC) メールの送信先アドレス(CC)を指定してください。
複数の送信先(CC)を使用する場合、各メールアドレスをカンマ区切りで指定してください。

MBC メール送信先(BCC) メールの送信先アドレス(BCC)を指定してください。
複数の送信先(BCC)を指定する場合、各メールアドレスをカンマ区切りで指定してください。

MFメール送信元メールの送信元アドレスを指定してください。※必須パラメータ
MSJメール件名メールの件名を指定してください。
MBメール本文メールの本文を指定してください。
MA 添付ファイル名 添付ファイル名を指定してください。
生成されたドキュメントの添付ファイル名となります。
※省略された場合、システムで管理されているファイル名がつけられます。

MR メール返信先 メールの返信先アドレスを指定してください。
MEF メールのEnvelope From Envelope Fromに、MFで指定したメール送信元を使用する場合は、「true」または「1」を指定してください。
無指定も含めて「true」または「1」ではない場合は、サーバーの既定値が使用されます。

OPROARTSからのレスポンスについて

OPROARTSを使用する場合の、リクエスト-レスポンスの流れは以下のようになります。

  1. クライアント(Webブラウザ、お客様アプリケーション等)がOPROARTSにHTTPSでリクエスト
  2. OPROARTSがドキュメント(PDF等)を生成
  3. OPROARTSがドキュメントを取得するためのURLを、リダイレクトレスポンスとして返却
  4. クライアントが、リダイレクトレスポンスに基づき、ドキュメントを取得(ダウンロード)

レスポンスには、以下のような種類があります。

1) 正常終了
OP=dlo, OP=dlpの場合:ドキュメントを取得するためのURLへとリダイレクトされます。
※「OPRO X Browser」「Adobe Reader」がインストールされている場合、関連付けに基づき、OPR、PDFが表示されます。

OP=mlo, OP=mlpの場合:メール送信リクエストの内容を示すHTMLが返却されます。

OP=dpの場合:ドキュメントを取得するためのURLへのリダイレクトされ、クライアントサイドで印刷が開始されます。
※クライアントPCに、「OPRO X Browser」がインストールされている必要があります。
2) CID、UID、UPWに誤りがある場合
ステータス=401が返却されます。
3) 月あたりの出力枚数が上限に達している場合
ステータス=402が返却されます。
4) 今回の作成で、月あたりの出力枚数の上限を超えてしまう場合
ドキュメントへのリダイレクト後、ステータス=402が返却されます
5) パラメータの内容に誤りがある場合(TPの間違いも含む)
ステータス=403が返却されます
6) CID/UIDで識別される一つの利用単位からの同時処理発生時
ステータス=503が返却されます
7) リクエストデータが5MBより大きい場合
ステータス=413が返却されます
8) 上記以外の異常時:
ステータス=500が返却されます
Copyright: © 2010 OPRO Japan Co., Ltd. - 日本オプロ株式会社 https://www.opro.net/