テンプレートを指定して、ドキュメントを作成し、編集し、結果を取得します。

Edition Flex の連携用API一覧
本WebアプリケーションのURLの後に、/document/API を指定します。

getの例:
http://demo.reso.co.jp/flex/document/jpeg?flexId=xxxxxxx&rasterDpi=50&pageList=1

postの例:

Flexの存在確認
API説明パラメータ
alive flexの生存確認をします。
生存していれば、"alive" という文字列が返ります。
このAPIは呼び出し後にセッションを破棄します。
なし

編集開始(編集画面無しで、PDF生成、JPEG生成も同様)
API説明パラメータ
layout テンプレートを指定して、編集を開始します。
認証:
relayUserId : 連携ログイン用ユーザID
dtime : 連携ログイン日時
clientId : 連携ログインクライアントID
呼び出し画面:
prepareName : 編集開始画面ページ名(呼び出し画面)
結果:
resultType : 連携ログイン結果取得タイプ
resultName : 編集終了画面ページ名(戻り画面)
returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ)
returnURL : 連携ログイン後の戻りURL
errorURL : エラー時の戻りURL
編集対象:
resourceType : 取得するリソースのタイプ(*"template"/"document"/"cassette")
srcType : テンプレート指定方法
└ "create" : 新規テンプレート作成
└ "trackingId" : テンプレート識別コード
└ "templateName" : テンプレート名称
└ "flexScript" : flexScriptで指定
└ "remotefile" : URLで lla ファイルを指定
└ "flexId" : 既にFlexにドキュメントがある場合そのflexIdで指定

pageSize : srcTypeが "create" の場合のページサイズ(CSVで指定)省略時はA4縦余白無し
  幅, 高さ, 上余白, 右余白, 下余白, 左余白
trackingId : srcTypeが "trackingId" の場合のテンプレート識別コード
templateName : srcTypeが "templateName" の場合のテンプレート名
flexScript : srcTypeが "flexScript" の場合のページ定義
remotefile : srcTypeが "remotefile" の場合のURL
└remoteUser : remotefileのBasic認証ID
└remotePasswd : remotefileのBasic認証パスワード
編集画面:
editorType : 編集タイプ
forceLayout : 編集中の場合でも強制的に編集開始する(multiMode == false時)
multiMode : 同一セッション複数編集モード
purposeName : 編集画面の用途
pagePurposeNames : ページ毎の用途(カンマ区切り)
pageNo : 編集開始ページ
pageSaveURL : 編集画面で「保存」された場合の通知先
pageSaveMode : pageSaveURLが指定された場合の通知方法
pageSavePath : 保存時のパス
pageSaveName : 保存時の名前
savedAtEnd : 編集画面終了時自動保存
その他オプション:
layoutId : 編集画面呼び出し時のID(任意)
checkMaterial : 素材・カセットの存在チェック
injectionData : 差し込みデータ
editScript : 編集スクリプト
enableIncludedEditScript : テンプレート同梱スクリプトの実行フラグ
editorLaml : editor.laml(テンプレートのeditor.lamlよりも優先します)
layoutAgain 編集画面終了後、編集画面に戻る際に呼び出します。
セッション中でのみ利用可能です。
なし
upload テンプレートをアップロードします。
formで画面遷移をするためには、予め relay でセッションを開始しておく必要があります。
アップロード編集の例

あるいは、editorType=injection, resultType=textで、Webアプリから呼び出し、flexIdを結果として取得し、 そのflexIdを layout API のパラメータで指定して編集を開始する事もできます。
基本的に layout API と同じです。(srcTypeは指定できません)
ブラウザのファイルアップロード同様、
multipart/form-dataでPOSTします。
resourcefile : ファイルアップロードのパラメータ名

Flexが保存している編集結果の取得と削除
API説明パラメータ
relay download, pdf, jpeg, remove, upload を呼び出す際に、
予めログインしておく為に呼び出します。
Edition Flexに連携ログインし、セッションを開始します。
認証:
relayUserId : 連携ログイン用ユーザID
dtime : 連携ログイン日時
clientId : 連携ログインクライアントID
結果:
resultType : 連携ログイン結果取得タイプ
resultName : 編集終了画面ページ名(戻り画面)
returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ)
returnURL : 連携ログイン後の戻りURL
download 編集結果を .lla ファイルでダウンロードします。
対象:
flexId : 編集結果を示すID
pdf 編集結果を PDFファイルでダウンロードします。

ただし、background=trueを指定した場合には、
バックグラウンド処理情報を返します。

バックグラウンド処理は、queueIdを指定して、
bgprogress(進捗) / bgabort(中断) / bgdownload(結果取得)のAPIを利用して、操作します。
10分以内に処理が完了しない場合には、処理継続のために bgprogressを呼び出してください。
PDF生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、 そのパラメータに対して、個別のパラメータ指定で上書き指定します。
対象:
flexId : 編集結果を示すID
オプション:
pdfOptionSetName : PDFOption パラメータセット名(省略時"print")
highResolution : 高解像度指定ON/OFF
sampleMark : 見本マークON/OFF
sampleMarkStr : 見本マーク文字列
sampleMarkTrackingId : 見本マーク素材識別コード
trimMargine : 余白トリミングON/OFF
checkFont : フォントチェックON/OFF
pdfVersion : PDFバージョン
cmyk : CMYK出力ON/OFF
cmykJpegMode : CMYK出力時のJPEG画像のモード
pdfMasterPassword : PDFのマスターパスワード
pdfUserPassword : PDFのユーザパスワード
pdfPermissions : PDFの制限
background : バックグラウンド処理を開始 true/false
結果(background=trueの場合):
queueId : バックグラウンド処理識別子
documentName : ドキュメント名
cache : trueの場合、no-cacheヘッダを出力しない
jpeg 編集結果を JPEGファイルでダウンロードします。

ただし、background=trueを指定した場合には、
バックグラウンド処理情報を返します。

バックグラウンド処理は、queueIdを指定して、
bgprogress(進捗) / bgabort(中断) / bgdownload(結果取得)のAPIを利用して、操作します。
10分以内に処理が完了しない場合には、処理継続のために bgprogressを呼び出してください。
生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、 そのパラメータに対して、個別のパラメータ指定で上書き指定します。
対象:
flexId : 編集結果を示すID
オプション:
pdfOptionSetName : PDFOption パラメータセット名("省略時jpeg")
highResolution : 高解像度指定ON/OFF
sampleMark : 見本マークON/OFF
sampleMarkStr : 見本マーク文字列
sampleMarkTrackingId : 見本マーク素材識別コード
trimMargine : 余白トリミングON/OFF
checkFont : フォントチェックON/OFF
rasterDpi : JPEGのDPI(Dot Per Inchi)
rasterPxSize : JPEGの最大サイズ
rasterSmoothing : スムージングON/OFF
background : バックグラウンド処理を開始 true/false
結果(background=trueの場合):
queueId : バックグラウンド処理識別子
documentName : ドキュメント名
cache : trueの場合、no-cacheヘッダを出力しない
png 編集結果を PNGファイルでダウンロードします。

ただし、background=trueを指定した場合には、
バックグラウンド処理情報を返します。

バックグラウンド処理は、queueIdを指定して、
bgprogress(進捗) / bgabort(中断) / bgdownload(結果取得)のAPIを利用して、操作します。
10分以内に処理が完了しない場合には、処理継続のために bgprogressを呼び出してください。
生成時のパラメータは、pdfOptionSetNameで基本となるパラメータとして、 PDFOption設定ファイルののセット名を指定し、 そのパラメータに対して、個別のパラメータ指定で上書き指定します。
対象:
flexId : 編集結果を示すID
オプション:
pdfOptionSetName : PDFOption パラメータセット名("省略時png")
highResolution : 高解像度指定ON/OFF
sampleMark : 見本マークON/OFF
sampleMarkStr : 見本マーク文字列
sampleMarkTrackingId : 見本マーク素材識別コード
trimMargine : 余白トリミングON/OFF
checkFont : フォントチェックON/OFF
rasterDpi : PNGのDPI(Dot Per Inchi)
rasterPxSize : PNGの最大サイズ
rasterSmoothing : スムージングON/OFF
background : バックグラウンド処理を開始 true/false
結果(background=trueの場合):
queueId : バックグラウンド処理識別子
documentName : ドキュメント名
remove flexId : 編集結果を示すID
編集結果を削除します。
一定時間アクセスが無い場合も自動削除されますが、
明示的に削除する場合に利用します。
対象:
flexId : 編集結果を示すID

バックグラウンド処理の操作API
bgprogress バックグラウンド処理の状況を取得します。

バックグラウンド処理は、10分(デフォルト)で、タイムアウト停止しますので、それ以上処理を継続する場合は、時間内にbgprogressを定期的に呼び出してください。
対象:
queueId : バックグラウンド処理を示すID
結果:
status : 処理状態(queued|started|stopped|abortRequested)
statusString : 処理状態文字列(実行待|実行中|実行完了|中断処理中)
result : 処理結果(success|error|aborted)
extra : 処理結果付加情報(文字列)
bgabort バックグラウンド処理の中断を指示します。
バックグラウンド処理の都合上、即時ではなく、直近の停止可能タイミングでの停止となります。
対象:
queueId : バックグラウンド処理を示すID
結果:
abortresult : 中断依頼結果(abortRequested|invalidStatus) status : 処理状態(queued|started|stopped|abortRequested)
statusString : 処理状態文字列(実行待|実行中|実行完了|中断処理中)
result : 処理結果(success|error|aborted)
extra : 処理結果付加情報(文字列)
bgdownload バックグラウンド処理処理結果を取得します。
対象:
queueId : バックグラウンド処理を示すID
結果:
バックグラウンド処理が正常に終了していた場合には、 バックグラウンド処理ではない場合と同じデータをダウンロードします。
バックグラウンド処理が終了していない場合には、「400 Bad Request」を返します。
bgprogressにて状況を確認してから処理結果を取得してください。
以下のいずれかの方法でテンプレートを指定します。
指定方法srcType説明テンプレート指定パラメータ
識別コード指定 trackingId テンプレートプロバイダに登録済みのテンプレートを、識別コードで指定します。 trackingId : テンプレートの識別コード
テンプレート名称指定 templateName テンプレートプロバイダに登録済みのテンプレートを、名称で指定します。 templateName : テンプレート名
URL指定 remotefile Edition Flex からアクセス可能なURLでテンプレートのllaファイルを指定します。 remotefile : URL
remoteUser : Basci/Digest認証ユーザID
remotePasswd : Basci/Digest認証パスワード
Flexスクリプト指定 flexScript Flexスクリプトでテンプレートを指定します。 flexScript : Flexスクリプト
アップロード resourcefile テンプレート(.llaファイル)をアップロードします。 resourcefile : テンプレートファイル
layout / upload APIで編集を開始する際に指定するパラメータです。
パラメータ 項目 必須 説明 値もしくは例 補足
relayUserId 編集時のユーザID 必須 編集時のユーザIDを指定します。 editOnly Flexの利用アカウントを指定してください
dtime ログイン情報を生成した時刻 必須 ログイン情報を生成した時刻をRFC1123形式で指定します。 Fri, 12 Nov 2010 08:28:00 GMT flex呼び出し時に生成してください。
認証情報有効期間が、0以外に設定されている場合、有効期間の範囲外では呼び出しエラーとなります
clientId 呼び出し元の正当性を示すID 必須 dtimeと共通鍵を連結した文字列のMD5の値を指定します。 32Byteの半角英数字 共通鍵は、Flexアカウント毎に設定されています。
flexId 編集結果を示すID 省略可 download, pdf, jpeg, remove で対象を指定します。 35Byteの半角英数字 layout API 呼び出しからの戻り時に取得できます。
resultType 結果表示方法 省略可 編集終了時やエラー時などの結果表示方法を指定します。 "html":標準で用意されている画面を表示します。

"text":テキストで返します。
無指定または、"text"以外を指定した場合は、"html"指定となります。

"text"指定時に返る文字列の内容
1行目:ステータス
2行目:flexId
3行目:メッセージ
resultName 編集終了画面ページ名 省略可 編集終了時やエラー時などに表示する戻り画面を指定します。 連携ユーザにてログインし、個人設定から戻り画面を作成してください。 無指定または、戻り画面が存在しない場合は、デフォルトの編集終了画面を表示します。resultTypeが"html"以外の場合には無視します。
pageNo 編集開始ページ番号 省略可 編集開始時に表示するページ番号を指定します。 最初のページが1です。 省略時には1ページ目を表示します。
pageSaveURL ページ「保存」時通知先 省略可 編集画面での保存時に呼び出すURLです pageSaveModeが"svg"/"lla"の時のみ有効
svgの場合はテキスト、lla の場合はバイナリ(マルチフォーム)を送ります。
URLにGETパラメータを含められます。
通知内容は、pageSaveModeによります。
pageSaveMode pageSaveURLへの通知内容 省略可 Flexから外部へ保存する際のモード指定 "svg":保存されたページのSVGのみ
"lla":編集中ドキュメント全体のlla
"template":デフォルトテンプレートプロバイダへ保存
"cassette":デフォルトカセットプロバイダへ保存
"document":デフォルトドキュメントプロバイダへ保存
省略時には"flexId"です。
pageSaveTrackingId プロバイダへ保存する際のtrackingId 省略可 指定されたtrackingIdのリソースを上書きします。 pageSaveModeが"template"/"document"/"cassette"の時のみ有効
srcTypeがtrackingIdの時、pageSaveMode と resourceType が等しい場合に、リソースのtrackingIdを自動設定
無指定時編集画面中で保存した場合に新規作成され、以降、作成されたリソースのtrackingIdに設定される。
省略時は新規作成
pageSavePath プロバイダへ新規保存する際のvpath 省略可 指定されたパスに保存されます。 pageSaveModeが"template"/"document"/"cassette"の時のみ有効
pageSaveTrackingIdが(自動設定含め)設定されている場合には、無効
省略時は"/"
pageSaveName プロバイダへ新規保存する際の名前 省略可 指定された名前で保存されます。 pageSaveModeが"template"/"document"/"cassette"の時のみ有効
pageSaveTrackingIdが(自動設定含め)設定されている場合には、無効
省略時は、プロバイダ側で適当に設定されます。
savedAtEnd 編集画面終了時に自動で保存 省略可 true:結果画面を出さず、自動保存, false:無効 pageSaveModeが"template"/"document"/"cassette"の時のみ有効
編集画面終了時に結果画面を表示せず、自動で保存し、trackingIdをパラメータとして、returnURLへ画面遷移します。
省略時false
returnUserId 呼び出し元に戻る場合の連携ログイン用ユーザID 省略可 編集時のユーザIDを指定します。 省略時はrelayUserIdと同じ値とします
returnURL 戻り先URL 省略可 編集終了時に戻るURLを指定します。
編集結果をダウンロードするためのIDを付加して呼び出します。
http://... 指定しない場合は編集終了時に閉じるボタンのみの画面を表示します。
errorURL エラー発生時戻り先URL 省略可 エラー発生時時に戻るURLを指定します。 http://... 指定しない場合は戻り先URLに戻ります。
editorType エディタの形式 省略可 エディタの形式を選択します。 general(編集画面あり)
injection(編集画面なし)
none(編集画面も差込処理も無し)
指定しない場合は「general」を指定したものとします。
forceLayout 強制編集開始 省略可 通常(マルチモードでない場合)は一つのブラウザでは、同じFlexでは、呼び出し側アプリが異なっていたとしても、
同時に一つの編集画面しか使えません。
forceLayoutが未設定もしくはfalseの場合は、flexはそのユーザセッションで編集中の場合にはエラー画面を表示します。trueにした場合は、エラーとせず、強制的に編集開始します。
ただし、全く同時に編集を開始した場合など、開始時は別セッションだったものが、ブラウザによっては後で同じセッションになってしまう事があり、そのような場合には、falseでもエラーにならない場合があります。
このフラグをtrueにして同時編集となった場合に、前の編集画面で編集操作が継続されていた場合には、編集データが混ざり、正しい編集が行われませんので、特に問題が無い限りtrueにはしないでください。
true|false 指定しない場合は「false」を指定したものとします。
multiMode 複数画面同時編集 省略可 trueの場合、編集時情報を別々に管理することで、同一ユーザセッションで複数画面で同時編集を行う事が可能となります。
いずれかの編集画面でFlexからログアウトすると、同時編集中の全画面のデータが失われますので、ログアウトはできません。
true|false 指定しない場合は「false」を指定したものとします。
purposeName 用途 省略可 編集時の設定を選択します。
編集設定ファイルのpurposeと合わせてください。
user
designer
指定しない場合は「user」を指定したものとします。
pagePurposeNames ページ毎の用途 省略可 ページ切り替え時の用途をカンマ区切りで指定します。
定義されている場合はその用途に切り替わります
user,user2... 指定しない場合はページ切り替え時に用途は切り替わりません
layoutId 編集ID 省略可 編集画面呼び出し時に呼び出し側で設定する識別IDです。 呼び出し側アプリユーザIDなど
素材プロバイダの基準パスの中で${layoutId}として指定できます。
checkMaterial 素材チェック 省略可 素材・カセットの存在チェックをします
プロバイダから提供される素材が取得可能かどうかをチェックします
取得できない場合は編集を開始しません。
true|false 指定しない場合は「false」を指定したものとします。
injectionData 差し込みデータ 省略可 ラベル指定で、テキストパーツの文字列、イメージパーツのtrackingIdを指定します。 ラベル1[タブ]値1
ラベル2[タブ]値2
LAML形式(1階層)
editScript 編集スクリプト 省略可 スクリプトでの編集処理を指定します。 別途資料参照 groovyスクリプト形式
enableIncludedEditScript テンプレート同梱スクリプト実行フラグ 省略可 trueが指定されている場合、テンプレート同梱スクリプトがあれば実行します。
editScriptパラメータが指定されている場合、それと結合されて実行されます。
true|false 指定しない場合は「false」を指定したものとします。
resourceType 編集対象のタイプ srcTypeがtrackingIdで、pageSaveModeを指定する場合に必要 resourceTypeとpageSaveModeが等しい場合はtrackingIdで指定したリソースそのものを編集することを意味します。 template/document/cassette pageSaveTrackingIdを参照してください
srcType 種別 必須 編集の元データとするテンプレートの指定方法を表します。 trackingId
templateName
resourcefile
remotefile
flexScript
trackingId:識別コード
templateName:テンプレート名
resourcefile:.lla/.zipファイルをアップロード
remotefile:指定したURLからテンプレートをダウンロード
flexScript:Flexスクリプト指定
flexId:flexId指定
trackingId 識別コード srcType=trackingIdの場合に必須 編集の元にするテンプレートを指定します。 存在しない場合はエラー画面を表示します。
templateName テンプレート名 srcType=templateNameの場合に必須 編集の元にするテンプレートを指定します。 存在しない場合はエラー画面を表示します。
flexScript Flexスクリプト srcType=flexScriptの場合に必須 編集の元にするテンプレートをFlexスクリプトで指定します。 Flexスクリプトが正しくない場合はエラー画面を表示します。
remotefile テンプレートを取得するURL srcType=remotefileの場合に必須 編集の元にするテンプレートを指定したURLから取得します。 存在しない場合はエラー画面を表示します。
JavaのKeyStoreで信頼されていない場合(オレオレ証明書など)、接続時にエラーが発生します。
HTTPBuilderのSSL Configuration
に従い証明書をインポートすれば使えるようになると思われますが、プログラム側で対応しなければなりません。
flexId Flex上のドキュメント srcType=flexIdの場合に必須 upload API などで既にflexに登録されているドキュメントを指定する場合 存在しない場合はエラー画面を表示します。
remoteUser テンプレートを取得時のユーザ名 省略可 srcType=remotefileの場合に指定可能です。 Basic/Digest認証が必要な場合のユーザ名です。
remotePasswd テンプレートを取得時のパスワード 省略可 srcType=remotefileの場合に指定可能です。 Basic/Digest認証が必要な場合のパスワードです。
PDF / JPEGで、結果を取得する際に指定するパラメータです。
PDF/JPEG共通設定
設定名 説明
pageListString1,2,3....カンマ区切りで 1からの、取得したいページ番号
highResolutionbooleantrue|false高解像度
sampleMarkbooleantrue|false見本マーク有無
sampleMarkStrString見本マーク文字列
sampleMarkTrackingIdString見本マーク素材識別コード
trimMarginebooleantrue|false余白トリミング
checkFontbooleantrue|falseフォントチェック
PDF専用設定
設定名 説明
pdfVersionString1.3|1.4|1.5 ...PDFバージョン(1.3以上)
cmykJpegModeString"JPEG" / "RAW" / "Pass Through"CMYK-JPEG-MODE
cmykbooleantrue|falseCMYK出力(falseの場合はRGB出力)
bookmarkbooleantrue|falseページ名をPDFのブックマークに設定する(デフォルトはtrue)
pdfMasterPasswordString権限パスワード
pdfUserPasswordStringユーザパスワード
pdfPermissionsStringnoprint nomodify nocopy noannots制限(複数ある時は、スペースで区切ります)
マスターパスワード必須です。
showLayerString1,2表示するレイヤー番号(1~)をcsvで指定
hideLayerString1,2非表示にするレイヤー番号(1~)をcsvで指定(showLayer指定時は無効)
pdfOverprintModeString"Off" / "CMYK" / "K100" / "K95"オーバープリントモード指定
pdfx1a2001booleanPDF/X-1a:2001 準拠
pdfx1a2003booleanPDF/X-1a:2003 準拠
compressint0:無圧縮 1:スピード優先 6:バランス 9:サイズ優先PDF圧縮係数(0-9)
pdfxString"none" / "PDF/X-1a:2001" / "PDF/X-1a:2003" etc.PDF/X準拠レベル
outputintentString"JC200103" 他PDF/Xの出力インテント
TitleString"no title"文書のタイトル
CreatorString"edition flex"文書の作成に使用されたソフトウェア
SubjectString"sub title"文書のサブタイトル
AuthorString"auther"文書の作成者
KeywordsString"sample leaf"文書の内容を記述したキーワード
honoriccprofilebooleanfalse画像内に埋め込まれているICCカラープロファイルを適用(デフォルトはfalse=推奨値)
linearizebooleanWeb用最適化
optimizeboolean別工程で最適化
JPEG/PNG用設定
設定名 説明
rasterDpiintdpiラスター出力時のDPI
rasterPxSizeintpixelラスター出力時の最大ピクセルサイズ
rasterSmoothingbooleantrue|falseラスター出力時のスムージング処理の有無
rasterBitCountintビット数ラスター出力時のビット数(8/24/32)
rasterBackgroundColorStringRGB色ラスター出力時の背景色(デフォルトはnoneで白)
PNG専用設定
設定名 説明
rasterBackgroundTransparentbooleantrue/falseラスター出力時の背景を透過にする

※各パラメータは、個別指定の他、LAML形式にまとめて、printSettings というキーで一括指定することもできます。