DEVELOPERS
開発者向けドキュメント
自社の Web アプリ・業務システムから、印刷・FAX を送り、スキャン・FAX で届いた書類を受け取るための API です。
POST https://<テナント>.cloudpaper.appz.jp/api/v1/jobs
Authorization: Bearer cpk_… -
01
はじめに
API キーを作って、印刷を 1 枚送り、届いた書類を受け取るまで。curl の例つき。
-
02
概要と用語
Cloud Paper の仕組み・用語・原則。
-
03
API キー
API キーの作り方・範囲（scope）・期限・作り直し。
-
04
API リファレンス
テナントの REST API（/api/v1）の全エンドポイント。印刷・FAX・受け口・品目・履歴・着信。
-
05
Webhook
届いた書類・印刷の結果・着信の通知。署名の検証と、書類の取得と確認。
-
06
OCR と書類の認識
受け口の読み取りの設定、状態と理由のコード、結果の API、書類の種類と項目（認識）。
-
07
スマートフォンの写真を送る
PC を通さずに、アプリから受け口へ写真を入れる（POST /inboxes/{name}/items）。
-
08
受け付ける PDF
印刷・FAX で受け付ける PDF の条件（既定で拒否）。
-
09
上限
PC・サーバー・受け口・Webhook・API の回数の上限と、超えたときの動き。
-
10
PC のクライアント
PC に入れるクライアントの起動・設定画面・ローカル API・印刷・FAX・取り込み・着信。
Cloud PaperAPIいまの機械のまま、Web アプリとつなぐ。
印刷・FAX・スキャンの取り込みは、無料プランでずっと無料（カードの登録なし）。読み取りが要るときは、OCR プランへ。