Edition Flex 連携 API 呼出機能 API 2010/12/27 本 Web アプリケーションの URL の後に API を指定します 例 : http://demo.reso.co.jp/flex/document/jpeg?flexid=xxxxxxx&rasterdpi=50&pagelist=1 API 説明 パラメータ alive flexの生存確認をします 生存していれば "alive" という文字列が返ります このAPIは呼び出し後にセッションを破棄します なし Layout テンプレートを指定して 編集を開始します relayuserid : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientid : 連携ログインクライアントID pageno : 編集開始ページ returnuserid : 呼び出し元に戻る場合の連携ログイン用ユーザID( 省略時はrelayUserIdと同じ ) errorurl : エラー時の戻りURL editortype : 編集タイプ purposename : 編集画面の用途 checkmaterial : 素材 カセットの存在チェック srctype : テンプレート指定方法 trackingid : srctypeが 識別コード指定の場合のID templatename : srctypeが 名称指定の場合の名称 : srctypeがurl 指定の場合のURL remoteuser : の認証 ID remotepasswd : の認証パスワード templatelaml : srctype=templatelaml 時のページ定義 layoutagain 編集画面終了後 編集画面に戻る際に呼び出します セッション中でのみ利用可能です なし relay download, pdf, jpeg, remove, upload を呼び出す際に 予めログインしておく為に呼び出します Edition Flexに連携ログインし セッションを開始します relayuserid : 連携ログイン用ユーザID dtime : 連携ログイン日時 clientid : 連携ログインクライアントID returnuserid : 呼び出し元に戻る場合の連携ログイン用ユーザID( 省略時はrelayUserIdと同じ ) download 編集結果を.lla ファイルでダウンロードします flexid : 編集結果を示すID flexid : 編集結果を示すID highresolution : 高解像度指定 ON/OFF pdf jpeg 編集結果を PDF ファイルでダウンロードします 編集結果を JPEG ファイルでダウンロードします 複数ページの場合は ZIP アーカイブされます samplemark : 見本マークON/OFF samplemarkstr : 見本マーク文字列 trimmargine : 余白トリミングON/OFF 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 : 見本マーク文字列 trimmargine : 余白トリミングON/OFF checkfont : フォントチェックON/OFF rasterdpi : JPEGのDPI(Dot Per Inchi) rasterpxsize : JPEGの最大サイズ 1
Edition Flex 連携 API 呼出機能 API 2010/12/27 以下は特殊な場合に利用する API です upload テンプレートをアップロードして 編集を開始します 予め relay でセッションを開始しておく必要があります Web アプリケーションから upload したテンプレートを ユーザが編集することはできませんので upload の利用はユーザがブラウザからアップロードする場合に限定されます rastersmoothing : スムージングON/OFF errorurl : エラー時の戻りURL editortype : 編集タイプ purposename : 編集画面の用途 resourcefile : ファイルアップロードのパラメータ名 2
Edition Flex 連携 API テンプレート指定方法 2010/12/27 以下のいずれかの方法でテンプレートを指定します 指定方法 ScrType 説明 テンプレートパラメータ 識別コード指定 trackingid 登録済みのテンプレートを 識別コードで指定します trackingid : テンプレートの識別コード テンプレート名称指定 URL 指定 templatename 登録済みのテンプレートを 名称で指定します Edition Flex からアクセス可能なURLでテンプレートを指定します templatename : テンプレート名 : URL remoteuser : Basci/Digest 認証ユーザID remotepasswd : Basci/Digest 認証パスワード LAML 指定 templatelaml LAMLページ定義でテンプレートを指定します templatelaml : ページ定義 LAML アップロード resourcefile テンプレート (.llaファイル) をアップロードします resourcefile : テンプレートファイル 3
Edition Flex 連携 API 編集パラメータ 2010/12/27 layout / upload APIで編集を開始する際に指定するパラメータです パラメータ項目必須説明値もしくは例補足 relayuserid 編集時のユーザID 必須編集時のユーザIDを指定します editonly サーバ側の設定合わせて設定してください dtime ログイン情報を生成した時刻 必須 ログイン情報を生成した時刻をRFC1123 形式で指定します Fri, 12 Nov 2010 08:28:00 GMT flex 呼び出し時に生成してください 認証情報有効期間が 0 以外に設定されている場合 有効期間の範囲外では呼び出しエラーとなります clientid 呼び出し元の正当性を示すID 必須 dtimeと共通鍵を連結した文字列のmd5の値を指定します 32Byteの半角英数字 サーバ側の設定合わせて修正してください flexid 編集結果を示すID 省略可 download, pdf, jpeg, remove で対象を指定します 35Byteの半角英数字 layout API 呼び出しからの戻り時に取得できます resulttype 結果表示方法 省略可 編集終了時やエラー時などの結果表示方法を指定します html : 標準で用意されている画面を表示します "text": テキストで返します (1 行目ステータス 2 行目 flexid メッセージ) 無指定または "text" 以外を指定した場合は "html" 指定となります resultname 編集終了画面ページ名省略可編集終了時やエラー時などに表示するカスタムページを指定します 連携ユーザにてログインし 個人設定からカスタムページを作成してください 無指定または カスタムページが存在しない場合は デフォルトの編集終了画面を表示します resulttype が "html" 以外の場合には無視します pageno 編集開始ページ番号 省略可 編集開始時に表示するページ番号を指定します 最初のページが1です 省略時には1ページ目を表示します returnuserid 呼び出し元に戻る場合の連携ログイン用ユーザID 省略可 編集時のユーザIDを指定します 省略時はrelayUserIdと同じ値とします returnurl 戻り先 URL 省略可 編集終了時に戻るURLを指定します 編集結果をダウンロードするためのIDを付加して呼び出します http://... 指定しない場合は編集終了時に閉じるボタンのみの画面を表示します errorurl エラー発生時戻り先 URL 省略可 エラー発生時時に戻るURLを指定します http://... 指定しない場合は戻り先 URLに戻ります editortype エディタの形式 省略可 エディタの形式を選択します general none 指定しない場合は general を指定したものとします purposename 用途 省略可 素材 カセットの存在チェックをします編集時の設定を選択します user 編集設定ファイルのpurposeと合わせてください designer 指定しない場合は user を指定したものとします checkmaterial 素材チェック 省略可 プロバイダから提供される素材が取得可能かどうかをチェックします取得できない場合は編集を開始しません true false 指定しない場合は false を指定したものとします trackingid trackingid: 識別コード templatename templatename: テンプレート名 srctype 種別 必須 編集の元データとするテンプレートの指定方法を表します resourcefile resourcefile:.lla/.zipファイルをアップロード : 指定したURLからテンプレートをダウンロード templatelaml templatelaml:laml 文字列で定義 trackingid 識別コード srctype=trackingidの場合に必須 編集の元にするテンプレートを指定します 存在しない場合はエラー画面を表示します templatename テンプレート名 srctype=templatenameの場合に必須 編集の元にするテンプレートを指定します 存在しない場合はエラー画面を表示します templatelaml テンプレートLAML srctype=templatelamlの場合に必須 編集の元にするテンプレートをLAMLで指定します LAMLが正しくない場合はエラー画面を表示します 存在しない場合はエラー画面を表示します テンプレートを取得するURL srctype=の場合に JavaのKeyStoreで信頼されていない場合 ( オレオレ証明書など ) 接続時にエラーが発生します 編集の元にするテンプレートを指定したURLから取得します 必須 HTTPBuilderのSSL Configuration に従い証明書をインポートすれば使えるようになると思われますが プログラム側で対応しなければなりません remoteuser テンプレートを取得時のユーザ名 省略可 srctype=の場合に指定可能です Basic/Digest 認証が必要な場合のユーザ名です remotepasswd テンプレートを取得時のパスワード 省略可 srctype=の場合に指定可能です Basic/Digest 認証が必要な場合のパスワードです 4
Edition Flex 連携 API 結果取得パラメータ 2010/12/27 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 フォントチェック PDF 専用設定 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 制限 ( 複数ある時は スペースで区切ります ) JPEG 専用設定 rasterdpi int dpi ラスター出力時のDPI rasterpxsize int pixel ラスター出力時の最大ピクセルサイズ rastersmoothing boolean true false ラスター出力時のスムージング処理の有無 各パラメータは 個別指定の他 LAML 形式にまとめて printsettings というキーで一括指定することもできます 5