Microsoft Word - FlexAPI docx

Transcription

1 株 式 会 社 レゾロジック Flex API 仕 様 書 Edition Flex Application Program Interface RESOLOGIC 2012/04/10 Edition Flex API 仕 様 書

2 内 容 1 呼 び 出 し 機 能 (API) 一 覧 Get Post Flex の 存 在 確 認 編 集 開 始 ( 編 集 画 面 無 しの 場 合 も 同 様 ) Flex が 保 存 している 編 集 結 果 の 取 得 と 削 除 バックグラウンド 処 理 の API 各 種 テンプレート 指 定 方 法 編 集 パラメーター 結 果 取 得 パラメータ

3 1 呼 び 出 し 機 能 (API) 一 覧 1.1 Get Web アプリケーションの URL の 後 に /document/api を 指 定 します Post Web アプリケーションの URL の 後 に /document/api を 指 定 します <form method="post" action=" <input type="hidden" name="relayuserid " value="xxxx"> : <input type="hidden" name="srctype" value="flexscript"> <textarea name="flexscript">page</textarea> : </form> 1.3 Flex の 存 在 確 認 alive flex の 生 存 確 認 をします 生 存 していれば "alive" という 文 字 列 が 返 ります この API は 呼 び 出 し 後 にセッションを 破 棄 します なし 1.4 編 集 開 始 ( 編 集 画 面 無 しの 場 合 も 同 様 ) Layout テンプレートを 指 定 して 編 集 を 開 始 します 認 証 : relayuserid : 連 携 ログイン 用 ユーザ ID dtime : 連 携 ログイン 日 時 clientid : 連 携 ログインクライアント ID 2

4 呼 び 出 し 画 面 : preparename : 編 集 開 始 画 面 ページ 名 ( 呼 び 出 し 画 面 ) 結 果 : resulttype : 連 携 ログイン 結 果 取 得 タイプ resultname : 編 集 終 了 画 面 ページ 名 ( 戻 り 画 面 ) returnuserid : 呼 び 出 し 元 に 戻 る 場 合 の 連 携 ログイン 用 ユーザ ID( 省 略 時 は relayuserid と 同 じ) returnurl : 連 携 ログイン 後 の 戻 り URL errorurl : エラー 時 の 戻 り URL 編 集 対 象 : srctype : テンプレート 指 定 方 法 "trackingid" : テンプレートプロバイダのテンプレート 識 別 コード "templatename" : テンプレートプロバイダのテンプレート 名 称 "flexscript" : flexscript で 指 定 "remotefile" : URL で lla ファイルを 指 定 trackingid : srctype が "trackingid" の 場 合 のテンプレート 識 別 コード templatename : srctype が "templatename" の 場 合 のテンプレート 名 flexscript : srctype が "flexscript" の 場 合 のページ 定 義 remotefile : srctype が "remotefile" の 場 合 の URL remoteuser : remotefile の Basic 認 証 ID remotepasswd : remotefile の Basic 認 証 パスワード 編 集 画 面 : editortype : 編 集 タイプ purposename : 編 集 画 面 の 用 途 pagepurposenames : ページ 毎 の 用 途 (カンマ 区 切 り) pageno : 編 集 開 始 ページ pagesaveurl : 編 集 画 面 で 保 存 された 場 合 の 通 知 先 pagesavemode : pagesaveurl が 指 定 された 場 合 の 通 知 方 法 その 他 オプション: layoutid : 編 集 画 面 呼 び 出 し 時 の ID( 任 意 ) 3

5 checkmaterial : 素 材 カセットの 存 在 チェック InjectionData : 差 し 込 みデータ editscript : 編 集 スクリプト enableincludededitscript : テンプレート 同 梱 スクリプトの 実 行 フラグ editorlaml : editor.laml(テンプレートの editor.laml よりも 優 先 します) layoutagain 編 集 画 面 終 了 後 編 集 画 面 に 戻 る 際 に 呼 び 出 します セッション 中 でのみ 利 用 可 能 です なし Upload テンプレートをアップロードして 編 集 を 開 始 します 予 め relay でセッションを 開 始 しておく 必 要 があります Web アプリケーションから upload したテンプレートを ユーザが 編 集 することはできませんので upload の 利 用 はユーザがブラウザからアップロードする 場 合 に 限 定 されます ResultType : 連 携 ログイン 結 果 取 得 タイプ resultname : 編 集 終 了 画 面 ページ 名 returnurl : 連 携 ログイン 後 の 戻 り URL errorurl : エラー 時 の 戻 り URL editortype : 編 集 タイプ purposename : 編 集 画 面 の 用 途 pagepurposenames : ページ 毎 の 用 途 (カンマ 区 切 り) resourcefile : ファイルアップロードのパラメータ 名 4

6 1.5 Flex が 保 存 している 編 集 結 果 の 取 得 と 削 除 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 を 指 定 した 場 合 には バックグラウンド 処 理 情 報 を 返 します 5

7 バックグラウンド 処 理 は queueid を 指 定 して bgprogress( 進 捗 ) / bgabort ( 中 断 ) / bgdownload( 結 果 取 得 )の API を 利 用 して 操 作 します 10 分 以 内 に 処 理 が 完 了 しない 場 合 には 処 理 継 続 のために bgprogress を 呼 び 出 してください 対 象 : flexid : 編 集 結 果 を 示 す ID オプション: 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 : ドキュメント 名 jpeg 編 集 結 果 を JPEG ファイルでダウンロードします ただし background=true を 指 定 した 場 合 には バックグラウンド 処 理 情 報 を 返 します バックグラウンド 処 理 は queueid を 指 定 して bgprogress( 進 捗 ) / bgabort ( 中 断 ) / bgdownload( 結 果 取 得 )の API を 利 用 して 操 作 します 6

8 10 分 以 内 に 処 理 が 完 了 しない 場 合 には 処 理 継 続 のために bgprogress を 呼 び 出 してください 対 象 : flexid : 編 集 結 果 を 示 す ID オプション: 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 : ドキュメント 名 flexid : 編 集 結 果 を 示 す ID remove flexid : 編 集 結 果 を 示 す ID 編 集 結 果 を 削 除 します 一 定 時 間 アクセスが 無 い 場 合 も 自 動 削 除 されますが 明 示 的 に 削 除 する 場 合 に 利 用 します 対 象 : flexid : 編 集 結 果 を 示 す ID 7

9 1.6 バックグラウンド 処 理 の API bgprogress バックグラウンド 処 理 の 状 況 を 取 得 します バックグラウンド 処 理 は 10 分 (デフォルト)で タイムアウト 停 止 しますの で それ 以 上 処 理 を 継 続 する 場 合 は 時 間 内 に bgprogress を 定 期 的 に 呼 び 出 して ください 対 象 : queueid : バックグラウンド 処 理 を 示 す ID 結 果 : status : 処 理 状 態 (queued started stopped abortrequested) statusstring : 処 理 状 態 文 字 列 ( 実 行 待 実 行 中 実 行 完 了 中 断 処 理 中 ) result : 処 理 結 果 (success error aborted) extra : 処 理 結 果 付 加 情 報 ( 文 字 列 ) bgabor バックグラウンド 処 理 の 中 断 を 指 示 します バックグラウンド 処 理 の 都 合 上 即 時 ではなく 直 近 の 停 止 可 能 タイミングでの 停 止 となります 対 象 : queueid : バックグラウンド 処 理 を 示 す ID 結 果 : abortresult : 中 断 依 頼 結 果 (abortrequested invalidstatus) status : 処 理 状 態 (queued started stopped abortrequested) statusstring : 処 理 状 態 文 字 列 ( 実 行 待 実 行 中 実 行 完 了 中 断 処 理 中 ) result : 処 理 結 果 (success error aborted) extra : 処 理 結 果 付 加 情 報 ( 文 字 列 ) 8

10 bgdownload バックグラウンド 処 理 処 理 結 果 を 取 得 します 対 象 : queueid : バックグラウンド 処 理 を 示 す ID 結 果 : バックグラウンド 処 理 が 正 常 に 終 了 していた 場 合 には バックグラウン ド 処 理 ではない 場 合 と 同 じデータをダウンロードします バックグラウンド 処 理 が 終 了 していない 場 合 には 400 Bad Request を 返 します bgprogress にて 状 況 を 確 認 してから 処 理 結 果 を 取 得 してください 9

11 2 各 種 テンプレート 指 定 方 法 以 下 のいずれかの 方 法 でテンプレートを 指 定 します 指 定 方 法 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 : テンプレートファイル 10

12 3 編 集 パラメーター layout / upload API で 編 集 を 開 始 する 際 に 指 定 するパラメータです パラメータ : relayuserid 項 目 : 編 集 時 のユーザ ID 必 須 : 必 須 編 集 時 のユーザ ID を 指 定 します 値 もしくは 例 : editonly 補 足 : Flex の 利 用 アカウントを 指 定 してください パラメータ : dtime 項 目 : ログイン 情 報 を 生 成 した 時 刻 必 須 : 必 須 ログイン 情 報 を 生 成 した 時 刻 を RFC1123 形 式 で 指 定 します 値 もしくは 例 : Fri, 12 Nov :28:00 GMT 補 足 : flex 呼 び 出 し 時 に 生 成 してください 認 証 情 報 有 効 期 間 が 0 以 外 に 設 定 されている 場 合 有 効 期 間 の 範 囲 外 では 呼 び 出 しエラーとなりま す パラメータ : clientid 項 目 : 呼 び 出 し 元 の 正 当 性 を 示 す ID 必 須 : 必 須 dtime と 共 通 鍵 を 連 結 した 文 字 列 の MD5 の 値 を 指 定 します 値 もしくは 例 : 32Byte の 半 角 英 数 字 補 足 : 共 通 鍵 は Flex アカウント 毎 に 設 定 されています パラメータ : flexid 項 目 : 編 集 結 果 を 示 す ID download, pdf, jpeg, remove で 対 象 を 指 定 します 値 もしくは 例 : 35Byte の 半 角 英 数 字 補 足 : layout API 呼 び 出 しからの 戻 り 時 に 取 得 できます 11

13 パラメータ : resulttype 項 目 : 結 果 表 示 方 法 編 集 終 了 時 やエラー 時 などの 結 果 表 示 方 法 を 指 定 します 値 もしくは 例 : "html": 標 準 で 用 意 されている 画 面 を 表 示 します "text":テキストで 返 します 補 足 : 無 指 定 または "text" 以 外 を 指 定 した 場 合 は "html" 指 定 となります text 指 定 時 に 返 る 文 字 列 の 内 容 1 行 目 :ステータス 2 行 目 :flexid 3 行 目 :メッセージ パラメータ : resultname 項 目 : 編 集 終 了 画 面 ページ 名 編 集 終 了 時 やエラー 時 などに 表 示 する 戻 り 画 面 を 指 定 します 値 もしくは 例 : 連 携 ユーザにてログインし 個 人 設 定 から 戻 り 画 面 を 作 成 してください 補 足 : 無 指 定 または 戻 り 画 面 が 存 在 しない 場 合 は デフォルトの 編 集 終 了 画 面 を 表 示 します resulttype が"html" 以 外 の 場 合 には 無 視 します パラメータ : pageno 項 目 : 編 集 開 始 ページ 番 号 編 集 開 始 時 に 表 示 するページ 番 号 を 指 定 します 値 もしくは 例 : 最 初 のページが1です 補 足 : 省 略 時 には1ページ 目 を 表 示 します パラメータ : pagesaveurl 項 目 : ページ 保 存 時 通 知 先 指 定 された 場 合 に ページ 保 存 時 に 呼 び 出 します 値 もしくは 例 : 補 足 : URL に GET パラメータを 含 められます 通 知 内 容 は pagesavemode によります 12

14 パラメータ : pagesavemode 項 目 : pagesaveurl への 通 知 内 容 pagesaveurl へ 通 知 する 内 容 を 指 定 します 値 もしくは 例 : "svg": 保 存 されたページの SVG のみ "lla": 編 集 中 ドキュメント 全 体 の lla 補 足 : 省 略 時 には"svg"です パラメータ : returnuserid 項 目 : 呼 び 出 し 元 に 戻 る 場 合 の 連 携 ログイン 用 ユーザ ID 編 集 時 のユーザ ID を 指 定 します 値 もしくは 例 : 補 足 : 省 略 時 は relayuserid と 同 じ 値 とします パラメータ : returnurl 項 目 : 戻 り 先 URL 編 集 終 了 時 に 戻 る URL を 指 定 します 編 集 結 果 をダウンロードするための ID を 付 加 して 呼 び 出 します 値 もしくは 例 : 補 足 : 指 定 しない 場 合 は 編 集 終 了 時 に 閉 じるボタンのみの 画 面 を 表 示 します パラメータ : errorurl 項 目 : エラー 発 生 時 戻 り 先 URL エラー 発 生 時 時 に 戻 る URL を 指 定 します 値 もしくは 例 : 補 足 : 指 定 しない 場 合 は 戻 り 先 URL に 戻 ります パラメータ : editortype 項 目 : エディタの 形 式 エディタの 形 式 を 選 択 します 値 もしくは 例 : general( 編 集 画 面 あり) injection( 編 集 画 面 なし) none( 編 集 画 面 も 差 込 処 理 も 無 し) 補 足 : 指 定 しない 場 合 は general を 指 定 したものとします 13

15 パラメータ : 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 階 層 14

16 パラメータ : editscript 項 目 : 編 集 スクリプト スクリプトでの 編 集 処 理 を 指 定 します 値 もしくは 例 : 別 途 資 料 参 照 補 足 : groovy スクリプト 形 式 パラメータ : enableincludededitscript 項 目 : テンプレート 同 梱 スクリプト 実 行 フラグ true が 指 定 されている 場 合 テンプレート 同 梱 スクリプトがあれば 実 行 します editscript パラメータが 指 定 されている 場 合 それと 結 合 されて 実 行 されます 値 もしくは 例 : true false 補 足 : 指 定 しない 場 合 は false を 指 定 したものとします パラメータ : srctype 項 目 : 種 別 必 須 : 必 須 編 集 の 元 データとするテンプレートの 指 定 方 法 を 表 します 値 もしくは 例 : trackingid templatename resourcefile remotefile flexscript 補 足 : trackingid: 識 別 コード templatename:テンプレート 名 resourcefile:.lla/.zip ファイルをアップロード remotefile: 指 定 した URL からテンプレートをダウンロード flexscript:flex スクリプト 指 定 パラメータ : trackingid 項 目 : 識 別 コード 必 須 : srctype=trackingid の 場 合 に 必 須 編 集 の 元 にするテンプレートを 指 定 します 値 もしくは 例 : 補 足 : 存 在 しない 場 合 はエラー 画 面 を 表 示 します 15

17 パラメータ : templatename 項 目 : テンプレート 名 必 須 : srctype=templatename の 場 合 に 必 須 編 集 の 元 にするテンプレートを 指 定 します 値 もしくは 例 : 補 足 : 存 在 しない 場 合 はエラー 画 面 を 表 示 します パラメータ : flexscript 項 目 : Flex スクリプト 必 須 : srctype=flexscript の 場 合 に 必 須 編 集 の 元 にするテンプレートを Flex スクリプトで 指 定 します 値 もしくは 例 : 補 足 : Flex スクリプトが 正 しくない 場 合 はエラー 画 面 を 表 示 します パラメータ : remotefile 項 目 : テンプレートを 取 得 する URL 必 須 : srctype=remotefile の 場 合 に 必 須 編 集 の 元 にするテンプレートを 指 定 した URL から 取 得 します 値 もしくは 例 : 補 足 : 存 在 しない 場 合 はエラー 画 面 を 表 示 します パラメータ : remotefile 項 目 : テンプレートを 取 得 する URL 必 須 : srctype=remotefile の 場 合 に 必 須 編 集 の 元 にするテンプレートを 指 定 した URL から 取 得 します 値 もしくは 例 : 補 足 : 存 在 しない 場 合 はエラー 画 面 を 表 示 します Java の KeyStore で 信 頼 されていない 場 合 (オレオレ 証 明 書 など) 接 続 時 にエラーが 発 生 します HTTPBuilder の SSL Configuration に 従 い 証 明 書 をインポートすれば 使 えるようになると 思 われますが プログラム 側 で 対 応 しなければなりません パラメータ : remoteuser 項 目 : テンプレートを 取 得 時 のユーザ 名 srctype=remotefile の 場 合 に 指 定 可 能 です 値 もしくは 例 : 補 足 : Basic/Digest 認 証 が 必 要 な 場 合 のユーザ 名 です 16

18 パラメータ : remotepasswd 項 目 : テンプレートを 取 得 時 のパスワード srctype=remotefile の 場 合 に 指 定 可 能 です 値 もしくは 例 : 補 足 : Basic/Digest 認 証 が 必 要 な 場 合 のパスワードです 17

19 4 結 果 取 得 パラメータ PDF / JPEG で 結 果 を 取 得 する 際 に 指 定 するパラメータです PDF/JPEG 共 通 設 定 設 定 名 型 値 説 明 pagelist String 1,2,3... カンマ 区 切 りで 1からの 取 得 したいページ 番 号 highresolution boolean true false 高 解 像 度 samplemark boolean true false 見 本 マーク 有 無 samplemarkstr String 見 本 マーク 文 字 列 samplemarktrackingid String 見 本 マーク 素 材 識 別 コード trimmargine boolean true false 余 白 トリミング checkfont boolean true false フォントチェック PDF 専 用 設 定 設 定 名 型 値 説 明 pdfversion String PDF バージョン(1.3 以 上 ) "JPEG" / "RAW" cmykjpegmode String / "Pass Through" CMYK-JPEG-MODE cmyk boolean true false CMYK 出 力 (false の 場 合 は RGB 出 力 ) ページ 名 を PDF のブックマークに 設 定 する(デフォ bookmark boolean true false ルトは true) pdfmasterpassword String 権 限 パスワード pdfuserpassword String ユーザパスワード noprint nomodify nocopy 制 限 ( 複 数 ある 時 は スペースで 区 切 ります) pdfpermissions String noannots マスターパスワード 必 須 です showlayer String 1,2 表 示 するレイヤー 番 号 (1~)を csv で 指 定 非 表 示 にするレイヤー 番 号 (1~)を csv で 指 定 hidelayer String 1,2 (showlayer 指 定 時 は 無 効 ) 18

20 "Off" / "CMYK" / pdfoverprintmode String "K100" / "K95" オーバープリントモード 指 定 pdfx1a2001 boolean PDF/X-1a:2001 準 拠 pdfx1a2003 boolean PDF/X-1a:2003 準 拠 0: 無 圧 縮 1:スピ ード 優 先 6:バラ ンス 9:サイズ 優 compress int 先 PDF 圧 縮 係 数 (0-9) "none" / "PDF/X-1a:2001" / "PDF/X-1a:2003" pdfx String etc. PDF/X 準 拠 レベル outputintent String "JC200103" 他 PDF/X の 出 力 インテント Title String "no title" 文 書 のタイトル Creator String "edition flex" 文 書 の 作 成 に 使 用 されたソフトウェア Subject String "sub title" 文 書 のサブタイトル Author String "auther" 文 書 の 作 成 者 Keywords String "sample leaf" 文 書 の 内 容 を 記 述 したキーワード 画 像 内 に 埋 め 込 まれている ICC カラープロファイ honoriccprofile boolean FALSE ルを 適 用 (デフォルトは false= 推 奨 値 ) linearize boolean Web 用 最 適 化 optimize boolean 別 工 程 で 最 適 化 JPEG 専 用 設 定 設 定 名 型 値 説 明 rasterdpi int dpi ラスター 出 力 時 の DPI rasterpxsize int pixel ラスター 出 力 時 の 最 大 ピクセルサイズ rastersmoothing boolean true false ラスター 出 力 時 のスムージング 処 理 の 有 無 各 パラメータは 個 別 指 定 の 他 LAML 形 式 にまとめて printsettings というキー で 一 括 指 定 することもできます 19