[ Log In | Sign Up | Lost password? ]

Field Reports API (ver. 0.1) リファレンス

リクエストURL

JSON形式で記述したレンダリング・パラメータを下記URLにPOST(アップロード)してください。 サーバ側で動的にPDFを生成し,呼び出し側にバイナリ文字列として返却します。

https://labs.field-works.co.jp/webapi/render

レンダリング・パラメータ

帳票を構成するために必要なすべての情報をレンダリング・パラメータに記述します。

書式

レンダリング・パラメータの書式やテンプレートの作成方法については,Field Reportsのドキュメントを参照してください。

APIキー

Field Reports for Cloud β版では,settings辞書のapi-key要素にAPIキーを設定する必要があります。 アカウント登録して,APIキーを取得してください。

テンプレート

PDFテンプレートのサンプルとして,以下のテンプレートを用意しています。

名称パス名
見積書templates/mitumori.pdf
はがきの宛名面 (ヨコ)templates/atena_h.pdf
はがきの宛名面 (タテ)templates/atena_v.pdf

サンプルテンプレートを使用する場合は,表中のパス名を指定してください。

"template": {"src": "templates/mitumori.pdf"}

利用者側で用意した任意のテンプレートを使用する場合は,テンプレートファイルの格納場所をURLで指定してください。

"template": {"src": "http://example.com/template.pdf"}

もしくは,data URI scheme文字列としてインラインでレンダリング・パラメータに埋め込むことも可能です。

"template": {"src": "data:application/pdf;base64,AAAoAAAARgAAAMD....."}

フォント・リソース

以下の標準フォント・リソースが利用可能です。

リソース名説明
/Times-RomanTimes Roman体フォント
/Times-BoldTimesボールド体フォント
/Times-ItalicTimesイタリック体フォント
/Times-BoldItalicTimesボールド・イタリック体フォント
/HelveticaHelveticaフォント
/Helvetica-BoldHelveticaボールド体フォント
/Helvetica-ObliqueHelvetica斜体フォント
/Helvetica-BoldObliqueHelveticaボールド斜体フォント
/CourierCourierフォント
/Courier-BoldCourierボールドフォント
/Courier-ObliqueCourier斜体フォント
/Courier-BoldObliqueCourierボールド斜体フォント
/SymbolSymbolフォント
/ZapfDingbatsZapfDingbatsフォント
/KozMin-Regular小塚明朝体フォント
/KozGo-Medium小塚ゴシック体フォント

また,以下のIPAフォントが利用可能です。

リソース名説明
IPAmjMinchoIPAmj明朝
IPAGothicIPAゴシック
@IPAmjMinchoIPAmj明朝(縦組み)
@IPAGothicIPAゴシック(縦組み)

その他のフォントを使用する場合は,フォントリソースを定義してください。 フォントデータの格納場所は,URLもしくはdata URI scheme形式で指定してください。

画像リソース

定義済みの画像リソースは用意しておりません。 画像データの格納場所は,URLもしくはdata URI scheme形式で指定してください。

レスポンス

以下のHTTPステータスコードを返却します。

ステータスコード意味
200 OK正常終了
400 Bad Requestパラメータが間違っている。
401 UnauthorizedAPIキーが間違っている。
403 Forbidden単位時間あたりのアクセス数,もしくはページ数が上限を超えた。
500 Internal Server Errorその他の内部エラーが発生した。

正常終了した場合は,PDFのファイルイメージをバイナリ文字列として返却します。

正常終了でない場合には,以下のエラーメッセージを追加したレスポンスヘッダのみを返却します。

フィールド名説明
X-Reports-Errorエラーメッセージ