PDFをBase64にする必要があるのはどんなとき?
JSON、XML、多くのフォームはテキストしか扱えないため、PDFのようなバイナリファイルは、まずテキストとして書き表す必要があります。そのための一般的な方法がBase64です。
- APIに書類を送る: 電子請求書、電子署名、配送、文書管理などのサービスでは、content、file、dataといった名前の項目にPDFを入れるよう求められることがよくあります。
- 自分で作った連携機能をテストする: JSONを選べば、Postman、curl、単体テストにそのまま貼り付けられるリクエスト本文が手に入ります。エンコード用のコードを書く必要はありません。
- テキスト型の列や設定に保存する: 小さなテンプレートや証明書をテキストとして保存するシステムもあります。Base64にすれば、PDFも収まります。
- Webページに埋め込む: データURIを使えば、別のファイルを置かずにiframeでPDFを表示できます。小さな書類なら問題ありません。
curl、JavaScript、Pythonでのリクエスト例は、PDFをBase64でAPIに送る方法で手順を追って紹介しています。コードをファイルに戻すにはBase64をPDFに変換を、画像の場合は画像をBase64に変換を使ってください。
各形式の見た目
| 形式 | 先頭の文字列 | 主な使い道 |
|---|---|---|
| Base64コードのみ | JVBERi0 | APIの項目、JSON、XML、データベース |
| データURI | data:application/pdf;base64, | ブラウザのタブ、iframe、objectタグ |
| 76文字ごとに改行 | JVBERi0(短い行に分割) | メールの添付ファイル(MIME)、PEM形式のファイル |
| JSON | { "fileName": … } | 連携テスト用のリクエスト本文 |
うまくいかないときは
「このファイルをPDFとして開けませんでした」と表示される: ファイルの先頭に%PDF-という識別子がありません。Wordファイルや画像の名前を.pdfに変えただけかもしれません。まずPDFリーダーで開いてみるか、適切なツールで変換してください。
APIから内容が無効だと返される: ドキュメントで指示されていない限り、data:の接頭辞も改行も含まない、コードだけを送ったか確認してください。貼り付けたときに末尾が切れていないかも確かめてください。
テキストが長すぎて項目に入らない: PDF圧縮でPDFを小さくしてから、もう一度変換してください。コードも同じ割合で短くなります。