PDF Blocks API の概要
PDF Blocks とは何か、各アクションが従うモデル、そして API でできることのカタログについて説明します。
PDF Blocks は、PDF ドキュメントを扱うための安全で高速な、ステートレスな HTTP API です。ドキュメントを送信してアクションを指定するだけで、処理済みの PDF がそのままレスポンスとして返ってきます。管理が必要なアカウントの状態はなく、リクエストの完了後は何も保存されず、インストールが必要な SDK もありません。どのアクションも、任意の言語から実行できる単一の認証済み HTTPS 呼び出しです。
基本的な考え方
PDF が1つ入り、PDF が1つ出てきます。それぞれのアクションは純粋な変換です。ドキュメント(といくつかのパラメーター)を受け取り、新しいドキュメントを返し、何も保持しません。file フィールドに PDF を格納した multipart/form-data を送信すると、単一出力のアクションは 200 OK を返し、完成したドキュメントを application/pdf としてレスポンスボディに含めます。
各出力はそれ自体が有効な PDF であるため、次のアクションへの有効な入力になります。これにより、アクションを組み合わせることができます。複数のファイルを結合し、その結果に透かしを付与し、それを暗号化するというように、各ステップが次のステップにつながります。ディスクに一切触れずにパイプラインを構築する方法については、アクションの連結を参照してください。
アクションのカタログ
17のアクションを、機能ごとにグループ化しています。各カードから、それぞれの完全なリファレンスに移動できます。
結合と分割
順序付けられた PDF のリストを1つに結合します。
固定サイズのまとまりに分割します。
任意のページ境界で分割します。
各パートのバイトサイズに上限を設けます。
定義したパターンでページをグループ化します。
透かし
パスワードとセキュリティ
ドキュメントを暗号化します。
既知のパスワードでドキュメントを復号します。
権限フラグを設定します。
権限フラグをリセットします。
電子署名を削除します。
ページ
ページのサブセットを保持します。
ページのサブセットを除外します。
ページを90°、180°、270°回転します。
ページの順序を反転します。
ページを任意の順序に並べ替えます。
全体像(命名規則、アクションがどのように組み合わさるか、それぞれがどこにあるか)については、アクションの概要を参照してください。
PDF Blocks の特長
- 高速。 アクションは単一目的の変換であり、キューも往復もありません。リクエストを送信すれば、結果を直接ファイルにストリーミングできます。
- 安全でステートレス。 リクエストは HTTPS でのみ送信され、秘密のキーで認証されます。 ドキュメントはリージョン内で処理され、保存されることはありません。レスポンスが書き込まれた時点で、何も残りません。
- リージョンごとのデータレジデンシー。 同じカタログが10のリージョンで稼働しているため、コンプライアンス要件に応じた場所でドキュメントを処理できます。リクエストをそのリージョンのベース URL に向けるだけで、それ以外はすべて同じです。
| リージョン | ベース URL |
|---|---|
| グローバル | https://api.pdfblocks.com |
| 日本 | https://jp.api.pdfblocks.com |
| 米国 | https://us.api.pdfblocks.com |
| HIPAA 米国 | https://hipaa.api.pdfblocks.com |
| 欧州連合 | https://eu.api.pdfblocks.com |
| 英国 | https://uk.api.pdfblocks.com |
| カナダ | https://ca.api.pdfblocks.com |
| オーストラリア | https://au.api.pdfblocks.com |
| インド | https://in.api.pdfblocks.com |
| ブラジル | https://br.api.pdfblocks.com |
詳細については、リージョンとデータレジデンシーを参照してください。