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-Roman | Times Roman体フォント |
/Times-Bold | Timesボールド体フォント |
/Times-Italic | Timesイタリック体フォント |
/Times-BoldItalic | Timesボールド・イタリック体フォント |
/Helvetica | Helveticaフォント |
/Helvetica-Bold | Helveticaボールド体フォント |
/Helvetica-Oblique | Helvetica斜体フォント |
/Helvetica-BoldOblique | Helveticaボールド斜体フォント |
/Courier | Courierフォント |
/Courier-Bold | Courierボールドフォント |
/Courier-Oblique | Courier斜体フォント |
/Courier-BoldOblique | Courierボールド斜体フォント |
/Symbol | Symbolフォント |
/ZapfDingbats | ZapfDingbatsフォント |
/KozMin-Regular | 小塚明朝体フォント |
/KozGo-Medium | 小塚ゴシック体フォント |
また,以下のIPAフォントが利用可能です。
リソース名 | 説明 |
IPAmjMincho | IPAmj明朝 |
IPAGothic | IPAゴシック |
@IPAmjMincho | IPAmj明朝(縦組み) |
@IPAGothic | IPAゴシック(縦組み) |
その他のフォントを使用する場合は,フォントリソースを定義してください。 フォントデータの格納場所は,URLもしくはdata URI scheme形式で指定してください。
画像リソース
定義済みの画像リソースは用意しておりません。 画像データの格納場所は,URLもしくはdata URI scheme形式で指定してください。
レスポンス
以下のHTTPステータスコードを返却します。
ステータスコード | 意味 |
200 OK | 正常終了 |
400 Bad Request | パラメータが間違っている。 |
401 Unauthorized | APIキーが間違っている。 |
403 Forbidden | 単位時間あたりのアクセス数,もしくはページ数が上限を超えた。 |
500 Internal Server Error | その他の内部エラーが発生した。 |
正常終了した場合は,PDFのファイルイメージをバイナリ文字列として返却します。
正常終了でない場合には,以下のエラーメッセージを追加したレスポンスヘッダのみを返却します。
フィールド名 | 説明 |
X-Reports-Error | エラーメッセージ |