API連携 ドキュメント, Q&A + Support

ドキュメント

labelmake.jpのAPIは2つの機能を提供してます。PDFの作成とテンプレートの取得です。
シンプルなAPIを使用してあなたのサービスにPDFの作成機能を簡単に追加することができます。

*API連携についての概要はこちらのページをご覧ください。
*ドキュメントの不具合やご意見はこちらからお気軽にご連絡いただければと思います。
*利用には申請が必要です。お問い合わせからお気軽に相談していただければと思います。

POST https://api.labelmake.jp/v1/pdf

PDF作成

リクエストパラメーター

NameDescription
templateテンプレートIDもしくはテンプレートデータを指定します。テンプレートデータの詳細はこちら
テンプレートIDはご自身で作成したテンプレートに加えてlabelmake.jp公式のテンプレートIDも使用できます
inputsテンプレートの入力項目に対応したデータを指定します。配列の要素がページに対応します
入力項目はテンプレートの取得時にsampledataとして参照可能です

サンプルコード(JS)

fetch("https://api.labelmake.jp/v1/pdf", {
  method: "POST",
  headers: {
    "X-Labelmake-API-Token": "{{REPLACE_ME}}",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
      inputs: [{
          "品名": "書類",
          "[お届け先]社名": "株式会社labelmake.jp",
          "[お届け先]郵便番号": "1234567",
          "[お届け先]住所": "東京都東京1-2-3-4 東京マンション123号",
          "[差出人]氏名": "大阪府 出得太",
          "[差出人]電話番号": "098-7654-4321",
          "[差出人]社名": "株式会社listmake.jp",
          "[お届け先]氏名": "東京都 出得太",
          "[お届け先]電話番号": "123-3456-7890",
          "[差出人]住所": "大阪府大阪1-2-3-4 大阪マンション123号",
          "[差出人]郵便番号": "7654321"
      }],
      template: '7aba5640-ea8a-11ea-bd67-419dd69ca92e',
  })
}).then((response) => response.blob());

Authorizationの{{REPLACE_ME}}マイページのAPI連携タブのAPI Tokenに入れ替えてください。

レスポンスサンプル

MIME Type
application/pdf

PDFデータのため省略

GET https://api.labelmake.jp/v1/templates

テンプレート一覧取得

リクエストパラメーター

NameDescription
teamlabelmakeと指定することでlabelmake.jp公式テンプレートの一覧が取得できます(任意)
省略した場合はマイページのテンプレート管理で確認できる、ご自身が作成したテンプレートの一覧が取得できます
tag指定したタグを含むテンプレートのみを返すように指定できます(任意)

サンプルコード(JS)

fetch("https://api.labelmake.jp/v1/templates?team=labelmake&tag=郵便局", {
  method: "GET",
  headers: {
    "X-Labelmake-API-Token": "{{REPLACE_ME}}"
  },
}).then((response) => response.json());

Authorizationの{{REPLACE_ME}}マイページのAPI連携タブのAPI Tokenに入れ替えてください。

レスポンスサンプル

MIME Type
application/json
[
  {
      "id": "7aba5640-ea8a-11ea-bd67-419dd69ca92e",
      "name": "レターパック",
      "description": "レターパックは、A4サイズ・4kgまで全国一律500円または350円で信書も送ることができるサービスです。  ラベルをA4で印刷して貼り付けてポストに投函できます。  白黒なのでレターパックプラス、ライトどちらも使用可能です。[**4面一気に記入できるレターパック4面テンプレートもあります。**](https://labelmake.jp/label-editor/?template=c48ff2d0-5ff0-11eb-b829-39d7d5e259af) <u>印刷サイズ:A4(210mmx297mm)</u> ",
      "tags": ["郵便局"],
      "photo": "https://firebasestorage.googleapis.com/v0/b/labelmake-a43f2.appspot.com/o/templates%2Fphoto%2F7aba5640-ea8a-11ea-bd67-419dd69ca92e.png?alt=media",
      "basePdf": "https://firebasestorage.googleapis.com/v0/b/labelmake-a43f2.appspot.com/o/templates%2FbasePdf%2F7aba5640-ea8a-11ea-bd67-419dd69ca92e.pdf?alt=media",
      "fontName": "SauceHanSansJP",
      "columns": ["[お届け先]郵便番号","[お届け先]住所","[お届け先]社名","[お届け先]氏名","[お届け先]電話番号","[差出人]郵便番号","[差出人]住所","[差出人]社名","[差出人]氏名","[差出人]電話番号","品名"],
      "sampledata": [{"品名": "書類","[差出人]社名": "株式会社listmake.jp","[お届け先]住所": "東京都東京1-2-3-4 東京マンション123号","[お届け先]氏名": "東京都 出得太","[差出人]電話番号": "098-7654-4321","[差出人]氏名": "大阪府 出得太","[お届け先]郵便番号": "1234567","[お届け先]電話番号": "123-3456-7890","[差出人]郵便番号": "7654321","[お届け先]社名": "株式会社labelmake.jp","[差出人]住所": "大阪府大阪1-2-3-4 大阪マンション123号"}],
      "schemas": [
          {
              "[差出人]電話番号": {"alignment": "left","lineHeight": 1,"width": 89.96,"position": {"y": 190.32,"x": 91},"fontSize": 15,"type": "text","characterSpacing": 0,"height": 7.35},
              "[お届け先]社名": {"position": {"y": 115.79,"x": 76.03},"fontSize": 13.5,"characterSpacing": 0,"type": "text","height": 8.13,"width": 98.17,"lineHeight": 1,"alignment": "right"},
              "[お届け先]電話番号": {"alignment": "left","width": 89.96,"position": {"x": 91,"y": 136.57},"fontSize": 15,"characterSpacing": 0,"lineHeight": 1,"type": "text","height": 6.54},
              "[差出人]郵便番号": {"alignment": "left","characterSpacing": 5.8,"lineHeight": 1,"type": "text","width": 40.28,"height": 6.28,"position": {"x": 77.9,"y": 146.63},"fontSize": 18},
              "[差出人]住所": {"type": "text","characterSpacing": 0,"position": {"x": 61.13,"y": 153.49},"fontSize": 13,"lineHeight": 1.2,"height": 18.45,"alignment": "left","width": 119.73},
              "[お届け先]氏名": {"characterSpacing": 0,"lineHeight": 1,"width": 113,"type": "text","height": 7.88,"position": {"y": 123.9,"x": 61},"alignment": "right","fontSize": 16},
              "[お届け先]郵便番号": {"lineHeight": 1,"fontSize": 40,"height": 18.2,"alignment": "left","position": {"y": 42,"x": 102.3},"characterSpacing": 12.7,"width": 85.79,"type": "text"},
              "[差出人]氏名": {"height": 7.07,"lineHeight": 1,"characterSpacing": 0,"alignment": "left","type": "text","fontSize": 15,"width": 107.95,"position": {"x": 73.01,"y": 180.33}},
              "品名": {"lineHeight": 1,"characterSpacing": 0,"position": {"x": 27.8,"y": 213.26},"alignment": "left","type": "text","height": 12.63,"width": 153.1,"fontSize": 18},
              "[差出人]社名": {"position": {"y": 173.86,"x": 76.12},"width": 104.78,"type": "text","lineHeight": 1,"characterSpacing": 0,"fontSize": 14,"height": 6.54,"alignment": "left"},
              "[お届け先]住所": {"width": 119.73,"height": 26.39,"alignment": "left","type": "text","position": {"x": 61.13,"y": 87.5},"characterSpacing": 0,"lineHeight": 1.4,"fontSize": 13}
          }
      ]
  }...
]

よくある質問 Q&A

Q:PDF作成の制約・性能について
A:月間1万リクエスト以下, 一度に作成できるPDFファイルのページ数は100枚以下, ファイルサイズは5MB以下の制約があります。

同時接続100,一括作成枚数100枚の動作確認済み。GCP(Google Cloud Platform)インフラ上でオートスケールし動作します。
labelmake.jpのテンプレートを使用した平均応答時間は820msです。(しかし応答スピードはPDFの作成処理の性能はPDFファイルのページ数,ファイルサイズに依存します。)
応答スピードにシビアなケースではご自身のテンプレートを使って計測することをおすすめしております。

Q:APIのお試しはいつまで使うことはできますか?
Q:サポートはありますか?

問題が解決しない場合はサポートします!

よくある質問をみても問題が解決しない場合、画面の右下のアイコン(channel)から管理人に直接チャットで問い合わせることができます。お気軽に問い合わせください。
応答がない場合は、こちらのコンタクトからお問い合わせしてもらえれば1日以内にお返事します。

解決しましたか?