JavaScript SDK

概要

Printgraph JS SDK は、JavaScript および TypeScript アプリケーションから Printgraph API を簡単に利用できるライブラリです。テンプレートからの PDF 生成を数行のコードで実現できます。

インストール

npm を使用してインストールできます：

npm install @printgraph/js-sdk

または、npm add コマンドでも追加できます：

npm add @printgraph/js-sdk

初期化

SDK を使用するには、まず Printgraph クライアントを初期化する必要があります。API キーは環境変数として設定することを推奨します。

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

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

API キーの取得

API キーの取得方法はこちらを参照してください。

基本的な使い方

PDF の生成

generatePDF() メソッドを使用して、テンプレートから PDF を生成できます：

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

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

// PDF を生成
const buf: ArrayBuffer = await client.generatePDF({
  template: "hello",
  params: {
    name: "world",
  },
});

// ファイルに保存
require("fs").writeFileSync("hello_world.pdf", buf);

パラメータの指定

params オブジェクトを使用して、テンプレートに動的なデータを渡すことができます：

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

API リファレンス

`new Printgraph(token: string)`

Printgraph クライアントのインスタンスを作成します。

パラメータ:

token (string): Printgraph API トークン

戻り値:

Printgraph クライアントインスタンス

`client.generatePDF(options: GeneratePDFOptions): Promise<ArrayBuffer>`

テンプレートから PDF を生成します。

パラメータ:

options.template (string): 使用するテンプレートの名前
options.params (object): テンプレートに渡すパラメータ

戻り値:

Promise<ArrayBuffer>: 生成された PDF のバイナリデータ

環境変数の設定

.env ファイルに API トークンを設定することを推奨します：

PRINTGRAPH_TOKEN=your_api_token_here

Node.js アプリケーションでは、dotenv パッケージを使用して環境変数を読み込めます：

npm install dotenv

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

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

TypeScript サポート

このSDKは完全に TypeScript で書かれており、型定義が含まれています。TypeScript プロジェクトでは自動的に型補完と型チェックが利用できます。

リポジトリ

SDK のソースコードは GitHub で公開されています： https://github.com/printgraph/js-sdk

JavaScript SDK

On this page