PRING ​公開 API — 外部の​システムから​ kintone の​帳票を​作る

PRING ​公開 API とは​何ですか

PRING の​プラグインは、​kintone の​画面から​帳票を​出します。​公開 API は、​その​帳票の​処理を、​外部の​システムから​呼ぶ​ための​入口です。​リクエストと​レスポンスは​ JSON ​(UTF-8) で、​帳票の​ファイルだけ​バイナリで​受け取ります。

使うのは、​情報システム部門、​システム開発会社 ​(SIer)、​kintone の​導入支援会社、​社内の​開発者です。​API の​入口は​ https://api.pring.tech/api/v1/ で、​人が​読む​ページは​この​サイトと​ヘルプに​置いています。

何を​自動化できますか

• 外部の​システムから​ kintone アプリに​レコードを​登録し、​そのまま​帳票 ​(PDF・​Excel・​Word) まで​作る​ ​(1 回の​呼び出し)
• kintone に​すでに​ある​レコードから、​帳票を​ 1 件作る
• レコードを​ 100 件まで​まとめて​登録し、​帳票を​まとめて​作る​ ​(ZIP 1​ つで​受け取る)
• PRING を​入れた​アプリと、​その​テンプレートの​一覧を​取得する
• 作った​帳票の​ファイルを​受け取る​ ​(15 分・​1 回だけ​開ける​リンク)。​kintone の​添付ファイル欄に​保存する​こともできる

kintone とは​どこで​接続しますか

対象は、​PRING の​プラグインを​入れた​ kintone アプリで​す。​帳票は、​その​アプリに​登録した​ PRING の​テンプレートで​作ります。

• kintone の​アプリの​設定で​ API トークンを​作り ​(権限は​「レコード追加」​「レコード編集」​「レコード閲覧」の​ 3 つだけ)、​PRING の​設定画面の​「API」​タブに、​アプリごとに​登録する
• 同じ​「API」​タブの​「アプリごとの​アクセス」で、​API から​使う​アプリを​「許可する」に​する。​範囲は​「読み取りのみ」か​「読み書き」から​選ぶ
• kintone の​ API トークンは、​PRING が​ kintone を​呼ぶ​ための​もの。​外部の​システムが​ PRING を​呼ぶ​ためには、​次の​ PRING の​ API キーを​使う

認証は​どうなっていますか

PRING の​ API キーを、​すべての​リクエストの​ Authorization ヘッダーに​ Bearer で​付けます。​キーは​設定画面の​「API」​タブで​発行します。​発行した​ときに​ 1 度だけ​表示され、​先頭は​本番用が​ prk_live_、​テスト用が​ prk_test_ です。

• キーに、​呼び出しを​許す​ IP アドレスを​ 20 個まで​付けられる​ ​(固定の​ IP アドレスから​呼ぶ​連携で、​キーが​漏れた​ときの​被害を​小さく​する)
• キーは​連携先の​システムごとに​分けて、​最大 20 個まで​持てる。​失効は​「API」​タブで​行い、​入れ替える​ときは、​新しい​キーを​発行してから​古い​キーを​失効する
• 通信は​ HTTPS だけで、​キーを​ URL に​入れる​形は​受け付けない

どんな​成果物を​作れますか

PDF・​Excel ​(xlsx)・​Word ​(docx) です。​形式は、​アプリに​登録した​テンプレートが​対応する​ものから​選びます。​数式・​結合セル・​書式を​保った​ Excel の​様式が、​そのまま​帳票に​なります。​作った​帳票は、​短い​時間だけ​開ける​リンクで​受け取るか、​kintone の​添付ファイル欄に​保存します。

上限と​レートの​目安は​ありますか

• 件数: 1 回の​リクエストで​ 1 レコード、​または​まとめて​ 100 件まで
• レート: API キーごとに​毎秒​ 100 リクエストまで。​契約ごとの​上限も​あり、​超えた​ときは​ 429 と​ Retry-After ​(待つ​秒数) が​返る
• ファイル: 生成した​ファイルの​リンクは​ 15 分・​1 回だけ​開ける。​まとめて​作った​ ZIP の​リンクは​ 24 時間
• 枚数: API で​作った​帳票は、​契約の​プランの​月間の​込み枚数に​数える​ ​(画面から​出した​ときと​同じ​数え方)
• レコードの​値は、​PRING の​サーバーに​保存せず、​処理中の​メモリだけで​扱う

料金と​プランの​関係は

最小の​実装例を​見せてください

アプリ番号 19 に​請求書の​レコードを​登録し、​テンプレート tpl_invoice の​ PDF まで​ 1 回で​作る​例です。​キーは​環境変数 PRING_API_KEY に​入れておきます。

curl -sS -X POST "https://api.pring.tech/api/v1/apps/19/records?render=tpl_invoice&format=pdf" \
  -H "Authorization: Bearer $PRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "record": { "顧客名": { "value": "サンプル商事" }, "請求日": { "value": "2026-11-01" } } }'

{
  "id": "105",
  "revision": "1",
  "file": {
    "id": "fil_01HXY...",
    "url": "https://api.pring.tech/api/v1/files/fil_01HXY...",
    "expires_at": "2026-11-01T09:15:00Z"
  }
}

エラーは、​RFC 7807 ​(Problem Details) の​形の​ JSON で​返ります。​detail に、​何を​直せばよいかが​書かれます。

{
  "type": "https://pring.tech/ja/help/developer/public-api#errors",
  "title": "Forbidden",
  "status": 403,
  "detail": "This API key does not have the render scope.",
  "instance": "/api/v1/apps/19/records/105/render"
}

ドキュメントは​どこに​ありますか

実装の​手順は、​技術者向けの​ヘルプ​「公開 API の​使い方」に​あります。​キーの​発行、​アプリごとの​アクセス、​curl・​Node.js・​Python の​例、​非同期の​ジョブ、​エラーの​一覧と​直し方、​上限の​詳細を​説明しています。

公開 API と​ MCP は​どう​使い分けますか

安全の​ために​何を​決めていますか

• API キーは、​使える​操作 ​(スコープ)・​使える​アプリ・​呼び出せる​ IP アドレスで​絞れる
• 使う​アプリは​「アプリごとの​アクセス」で​ 1 つずつ​許可する​ ​(既定は​許可しない)。​許可していない​アプリは、​API から​見えない
• kintone の​ API トークンは​暗号化して​保存し、​レコードの​登録と​取得の​ときだけ​使う
• キーは​失効でき、​入れ替える​ときも​連携を​止めずに​進められる

あわせて​読む

• 公開 API の使い方 (技術者向け)キーの発行、curl・Node.js・Python の例、非同期、エラーの直し方
• PRING MCPAI エージェントに頼んで帳票を作る。API と同じ認証・上限で動く
• 料金プランごとの月額と月間の込み枚数
• 販売パートナー募集API を使った拡張の提案も含めて、お客様に提案する
• 使い方事例購買・販売・経費などの業務アプリセットで帳票を出す例