Edition Flex 連携API 呼出機能API 2010/12/27 1

Edition Flex 連携API
呼出機能API 2010/12/27
Edition Flex の連携用API一覧
本WebアプリケーションのURLの後にAPIを指定します。
例： http://demo.reso.co.jp/flex/document/jpeg?flexId=xxxxxxx&rasterDpi=50&pageList=1
API
alive
説明
flexの生存確認をします。
生存していれば、"alive" という文字列が返ります。
このAPIは呼び出し後にセッションを破棄します。
パラメータ
なし
relayUserId : 連携ログイン用ユーザID
dtime : 連携ログイン日時
clientId : 連携ログインクライアントID
resultType : 連携ログイン結果取得タイプ
resultName : 編集終了画面ページ名
pageNo : 編集開始ページ
returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ)
returnURL : 連携ログイン後の戻りURL
errorURL : エラー時の戻りURL
Layout
テンプレートを指定して、編集を開始します。
editorType : 編集タイプ
purposeName : 編集画面の用途
checkMaterial : 素材・カセットの存在チェック
srcType : テンプレート指定方法
└ trackingId : srcTypeが、識別コード指定の場合のID
└ templateName : srcTypeが、名称指定の場合の名称
└ remotefile : srcTypeがURL指定の場合のURL
└ remoteUser : remotefileの認証ID
└ remotePasswd : remotefileの認証パスワード
└ templateLaml : srcType=templateLaml時のページ定義
layoutAgain
編集画面終了後、編集画面に戻る際に呼び出します。
なし
セッション中でのみ利用可能です。
relayUserId : 連携ログイン用ユーザID
dtime : 連携ログイン日時
relay
download, pdf, jpeg, remove, upload を呼び出す際に、
予めログインしておく為に呼び出します。
Edition Flexに連携ログインし、セッションを開始します。
clientId : 連携ログインクライアントID
resultType : 連携ログイン結果取得タイプ
resultName : 編集終了画面ページ名
returnUserId : 呼び出し元に戻る場合の連携ログイン用ユーザID(省略時はrelayUserIdと同じ)
returnURL : 連携ログイン後の戻りURL
download
編集結果を .lla ファイルでダウンロードします。
flexId : 編集結果を示すID
flexId : 編集結果を示すID
highResolution : 高解像度指定ON/OFF
sampleMark : 見本マークON/OFF
sampleMarkStr : 見本マーク文字列
trimMargine : 余白トリミングON/OFF
pdf
編集結果を PDFファイルでダウンロードします。
checkFont : フォントチェックON/OFF
pdfVersion : PDFバージョン
cmyk : CMYK出力ON/OFF
cmykJpegMode : CMYK出力時のJPEG画像のモード
pdfMasterPassword : PDFのマスターパスワード
pdfUserPassword : PDFのユーザパスワード
pdfPermissions : PDFの制限
flexId : 編集結果を示すID
highResolution : 高解像度指定ON/OFF
sampleMark : 見本マークON/OFF
sampleMarkStr : 見本マーク文字列
jpeg
編集結果を JPEGファイルでダウンロードします。
複数ページの場合はZIPアーカイブされます。
trimMargine : 余白トリミングON/OFF
checkFont : フォントチェックON/OFF
rasterDpi : JPEGのDPI(Dot Per Inchi)
rasterPxSize : JPEGの最大サイズ
1
Edition Flex 連携API
呼出機能API 2010/12/27
rasterSmoothing : スムージングON/OFF
以下は特殊な場合に利用するAPIです。
resultType : 連携ログイン結果取得タイプ
upload
テンプレートをアップロードして、編集を開始します。
予め relay でセッションを開始しておく必要があります。
Webアプリケーションからuploadしたテンプレートを、
ユーザが編集することはできませんので、
upload の利用はユーザがブラウザからアップロードする場合
に限定されます。
resultName : 編集終了画面ページ名
returnURL : 連携ログイン後の戻りURL
errorURL : エラー時の戻りURL
editorType : 編集タイプ
purposeName : 編集画面の用途
resourcefile : ファイルアップロードのパラメータ名
2
Edition Flex 連携API
テンプレート指定方法 2010/12/27
Edition Flex の連携用API一覧
以下のいずれかの方法でテンプレートを指定します。
指定方法
識別コード指定
ScrType
trackingId
説明
登録済みのテンプレートを、識別コードで指定します。
trackingId : テンプレートの識別コード
テンプレートパラメータ
テンプレート名称指定
templateName
登録済みのテンプレートを、名称で指定します。
templateName : テンプレート名
remotefile : URL
remoteUser : Basci/Digest認証ユーザID
URL指定
remotefile
Edition Flex からアクセス可能なURLでテンプレートを指定します。
LAML指定
templateLaml
LAMLページ定義でテンプレートを指定します。
templateLaml : ページ定義LAML
アップロード
resourcefile
テンプレート（.llaファイル）をアップロードします。
resourcefile : テンプレートファイル
remotePasswd : Basci/Digest認証パスワード
3
Edition Flex 連携API
編集パラメータ 2010/12/27
Edition Flex の連携用API一覧
layout / upload APIで編集を開始する際に指定するパラメータです。
パラメータ
項目
relayUserId
編集時のユーザID
必須
必須
説明
値もしくは例
編集時のユーザIDを指定します。
editOnly
補足
サーバ側の設定合わせて設定してください。
flex呼び出し時に生成してください。
dtime
ログイン情報を生成した時刻
必須
ログイン情報を生成した時刻をRFC1123形式で指定します。
Fri, 12 Nov 2010 08:28:00 GMT
clientId
呼び出し元の正当性を示すID
必須
dtimeと共通鍵を連結した文字列のMD5の値を指定します。
32Byteの半角英数字
flexId
編集結果を示すID
省略可
download, pdf, jpeg, remove で対象を指定します。
resultType
結果表示方法
省略可
編集終了時やエラー時などの結果表示方法を指定します。
35Byteの半角英数字
layout API 呼び出しからの戻り時に取得できます。
html ：標準で用意されている画面を表示しま
す
"text"：テキストで返します。（1行目ステータス、2 無指定または、"text"以外を指定した場合は、"html"指定となります。
行目flexId、メッセージ）
resultName
編集終了画面ページ名
省略可
編集終了時やエラー時などに表示するカスタムページを指定します。
連携ユーザにてログインし、個人設定からカスタ無指定または、カスタムページが存在しない場合は、デフォルトの編集終了画面を表示します。
resultTypeが"html"以外の場合には無視します。
ムページを作成してください。
pageNo
編集開始ページ番号
省略可
呼び出し元に戻る場合の連携ログイン用
省略可
ユーザID
編集開始時に表示するページ番号を指定します。
最初のページが１です。
returnUserId
returnURL
戻り先URL
省略可
errorURL
エラー発生時戻り先URL
省略可
認証情報有効期間が、0以外に設定されている場合、有効期間の範囲外では呼び出しエラーとなります
editorType
エディタの形式
省略可
purposeName
用途
省略可
checkMaterial
素材チェック
省略可
srcType
種別
trackingId
識別コード
templateName
テンプレート名
templateLaml
テンプレートLAML
必須
編集時のユーザIDを指定します。
サーバ側の設定合わせて修正してください。
省略時には１ページ目を表示します。
省略時はrelayUserIdと同じ値とします
編集終了時に戻るURLを指定します。
編集結果をダウンロードするためのIDを付加して呼び出します。
エラー発生時時に戻るURLを指定します。
http://...
指定しない場合は編集終了時に閉じるボタンのみの画面を表示します。
http://...
指定しない場合は戻り先URLに戻ります。
general
エディタの形式を選択します。
none
編集時の設定を選択します。
user
編集設定ファイルのpurposeと合わせてください。
素材・カセットの存在チェックをします
プロバイダから提供される素材が取得可能かどうかをチェックします
取得できない場合は編集を開始しません。
designer
true|false
編集の元データとするテンプレートの指定方法を表します。
srcType=trackingIdの場合に
編集の元にするテンプレートを指定します。
必須
srcType=templateNameの場
編集の元にするテンプレートを指定します。
合に必須
srcType=templateLamlの場
編集の元にするテンプレートをLAMLで指定します。
合に必須
指定しない場合は「general」を指定したものとします。
指定しない場合は「user」を指定したものとします。
指定しない場合は「false」を指定したものとします。
trackingId
trackingId:識別コード
templateName
templateName:テンプレート名
resourcefile
resourcefile:.lla/.zipファイルをアップロード
remotefile
remotefile:指定したURLからテンプレートをダウンロード
templateLaml
templateLaml:LAML文字列で定義
存在しない場合はエラー画面を表示します。
存在しない場合はエラー画面を表示します。
LAMLが正しくない場合はエラー画面を表示します。
テンプレートを取得するURL
srcType=remotefileの場合に
編集の元にするテンプレートを指定したURLから取得します。
必須
remoteUser
テンプレートを取得時のユーザ名
省略可
srcType=remotefileの場合に指定可能です。
存在しない場合はエラー画面を表示します。
JavaのKeyStoreで信頼されていない場合(オレオレ証明書など)、接続時にエラーが発生します。
HTTPBuilderのSSL Configuration
に従い証明書をインポートすれば使えるようになると思われますが、プログラム側で対応しなければなりません。
Basic/Digest認証が必要な場合のユーザ名です。
remotePasswd
テンプレートを取得時のパスワード
省略可
srcType=remotefileの場合に指定可能です。
Basic/Digest認証が必要な場合のパスワードです。
remotefile
4
Edition Flex 連携API
結果取得パラメータ 2010/12/27
Edition Flex の連携用API一覧
PDF / JPEGで、結果を取得する際に指定するパラメータです。
PDF/JPEG共通設定
設定名
pageList
型
String
値
1,2,3....
説明
カンマ区切りで 1からの、取得したいページ番号
highResolution
boolean
true|false
高解像度
sampleMark
boolean
true|false
見本マーク有無
sampleMarkStr
String
trimMargine
boolean
true|false
余白トリミング
checkFont
boolean
true|false
フォントチェック
設定名
pdfVersion
型
String
値
1.3|1.4|1.5
説明
PDFバージョン
cmykJpegMode
String
"JPEG" / "RAW" / "Pass
Through"
CMYK-JPEG-MODE
cmyk
boolean
true|false
カラープロファイル
pdfMasterPassword
String
pdfUserPassword
String
pdfPermissions
String
noannots
制限(複数ある時は、スペースで区切ります)
型
int
値
dpi
説明
ラスター出力時のDPI
見本マーク文字列
PDF専用設定
権限パスワード
ユーザパスワード
JPEG専用設定
設定名
rasterDpi
rasterPxSize
int
pixel
ラスター出力時の最大ピクセルサイズ
rasterSmoothing
boolean
true|false
ラスター出力時のスムージング処理の有無
※各パラメータは、個別指定の他、LAML形式にまとめて、printSettings というキーで一括指定することもできます。
5

Download Report