JavaScript SDK

パッケージ: @printgraph/js-sdk · GitHub

JavaScript / TypeScript アプリケーションから Printgraph API を簡単に利用できる公式 SDK です。 Node.js 環境での利用を想定しています。

インストール

npm install @printgraph/js-sdk

初期化

API キーを環境変数で管理することを推奨します。

PRINTGRAPH_TOKEN=your_api_key_here

import { Printgraph } from "@printgraph/js-sdk";

const client = new Printgraph(process.env.PRINTGRAPH_TOKEN);

基本的な使い方

generatePDF() メソッドでテンプレートから PDF を生成します。戻り値は ArrayBuffer です。

import { Printgraph } from "@printgraph/js-sdk";
import fs from "node:fs";

const client = new Printgraph(process.env.PRINTGRAPH_TOKEN);

const buf: ArrayBuffer = await client.generatePDF({
  templateKey: "hello-template",
  params: {
    name: "世界",
  },
});

fs.writeFileSync("hello.pdf", Buffer.from(buf));

params を使った動的なデータ埋め込み

import { Printgraph } from "@printgraph/js-sdk";
import fs from "node:fs";

const client = new Printgraph(process.env.PRINTGRAPH_TOKEN);

const buf = await client.generatePDF({
  templateKey: "invoice-template",
  params: {
    invoiceNumber: "INV-001",
    customerName: "山田太郎",
    amount: 10000,
    items: [
      { name: "商品A", price: 5000, quantity: 1 },
      { name: "商品B", price: 2500, quantity: 2 },
    ],
  },
});

fs.writeFileSync("invoice.pdf", Buffer.from(buf));

API リファレンス

`new Printgraph(token, options?)`

引数	型	説明
`token`	`string`	Printgraph API キー
`options.apiURL`	`string`	API の Base URL（デフォルト: `https://api.printgraph.jp/v1/`）

`client.generatePDF(options)`

オプション	型	必須	説明
`templateKey`	`string`	必須	テンプレートキー
`params`	`Record<string, string \| number \| boolean>`	任意	テンプレートに渡す変数

API キーの発行方法は API キーを参照してください。

テンプレートの作成方法はテンプレートを参照してください。