アプリにファイル変換を組み込む
FileConvertFree REST APIをアプリ、バックエンド、自動化、社内ワークフロー、業務システムから利用できます。
クイックスタート
APIプランと制限
制限は同一APIアカウントのすべてのキーで共有されます。キーを追加してもクォータは増えません。
Premium
200 / day- 200 1日あたりのリクエスト
- 30 1分あたりのリクエスト
- 200 MB 最大ファイルサイズ
- 3 有効なキー max
Pro
400 / day- 400 1日あたりのリクエスト
- 60 1分あたりのリクエスト
- 200 MB 最大ファイルサイズ
- 3 有効なキー max
APIキー管理
1. キーを作成
ダッシュボードの開発者APIセクションから、最大3個の有効なAPIキーを保持できます。Production、Office App、Stagingなど用途が分かる名前を付けてください。
2. 作成時に保存
完全なシークレットは作成または再生成の直後にのみ表示されます。FileConvertFreeは平文のシークレットではなく安全なハッシュを保存するため、後から完全なキーを再表示することはできません。
3. キーを再生成
再生成すると新しいシークレットが作られ、古いキーは直ちに無効になります。1回だけ表示される新しいシークレットを閉じる前にアプリ側の設定を更新してください。
4. キーを無効化
不要になったキーや漏えいの可能性があるキーは無効化してください。認証には直ちに使えなくなり、無効化されたキーの記録は7日後に自動削除されます。
セキュリティルール
APIキーを共有したり、GitHubなどの公開リポジトリへ掲載したり、ブラウザ側JavaScriptへ埋め込んだり、スクリーンショットで送ったりしないでください。サーバーの環境変数やシークレット管理サービスで保管し、漏えいの可能性がある場合は直ちに再生成または無効化してください。
利用可能なエンドポイント
| メソッド | エンドポイント | 用途 / オプション |
|---|---|---|
| GET | /v1/account/usage | 認証済みプラン、キー状態、1日の使用量、残りクォータ、レート制限の使用状況を取得します。 |
| GET | /health | APIの状態とバージョンを確認する公開ヘルスチェックです。 |
| POST | /v1/pdf/to-word | 有効なPDFファイルをWordへ変換します。 |
| POST | /v1/pdf/to-excel | 有効なPDFファイルをExcelへ変換します。 |
| POST | /v1/image/to-text | 画像からOCRでテキストを抽出します。任意のmultipartフィールド: fast=true|false。 |
| POST | /v1/image/to-word | 画像をWordへ変換します。任意のmultipartフィールド: fast=true|false。 |
| POST | /v1/image/to-excel | 画像をExcelへ変換します。任意のmultipartフィールド: fast=true|false。 |
| POST | /v1/image/remove-background | 画像の背景を削除します。任意のフィールド: format(既定png)、transparent=true|false、fast_mode=true|false。 |
コード例
対応ファイルと検証
PDFエンドポイントは実際のPDFファイルを受け付けます。画像エンドポイントはJPEG/JPG/JFIF、PNG、WebP、GIF、BMP、TIFF/TIFに対応します。APIはファイル名の拡張子と実際のファイルシグネチャの両方を検証するため、未対応ファイルの名前を変更しただけでは検証を回避できません。
レスポンスの動作
ファイル変換エンドポイントは変換済みファイル本体をクライアントへ直接返します。画像からテキストはJSONを返します。内部コンバーターのダウンロードURLはAPI利用者へ公開されません。
HTTPエラーと意味
| ステータス | 意味 | 主な原因 / 対応 |
|---|---|---|
| 401 | APIキーがない、無効、期限切れ、または無効化されています。 | X-API-Keyを確認してください。キーを無効化または再生成した場合は現在のシークレットへ更新してください。 |
| 403 | APIアクセスが有効ではありません。 | アカウントに現在有効なPremiumまたはProの権利がありません。 |
| 409 | キー操作が現在の状態と一致しません。 | 例: 有効なキーを3個より多く作成しようとした、無効なキーを再生成しようとした場合などです。 |
| 413 | アップロードファイルが大きすぎます。 | APIプランの上限内のファイルを使用してください(現在200MB)。 |
| 415 | 未対応または内容と一致しないメディアタイプです。 | 対応するPDF/画像を使用し、正しい拡張子を保持してください。APIはファイルシグネチャも検証します。 |
| 422 | リクエスト内容が無効です。 | アップロードが空、または必要なmultipartデータが不足・不正な可能性があります。 |
| 429 | リクエストが多すぎます。 | 1分あたりのレート制限またはアカウント全体の1日クォータに達しました。後で再試行するか、日次リセットを待ってください。 |
| 5xx | APIまたは変換サービスの一時的な障害です。 | 時間を空けて再試行してください。インフラ/バックエンド障害は1日クォータに課金されません。 |
クォータの計算方法
1日クォータと1分あたりのレート制限は、同じAPIアカウントのすべてのキーで共有されます。変換前に無効または未対応として拒否されたアップロードは1日クォータを消費しません。サーバーまたはインフラ障害はクォータへ戻されます。変換処理として受理されたリクエストは、下流コンバーターがクライアント側4xxエラーを返した場合でもカウントされることがあります。1日クォータはAPIサーバー/データベースの日付に基づいてリセットされます。
Usage check: GET https://fileconvertfree.com/api1/v1/account/usage
よくある質問
FreeアカウントでAPIを利用できますか?
いいえ。ドキュメントは誰でも閲覧できますが、現在APIアクセスには有効なPremiumまたはProプランが必要です。
キーを3個作るとクォータも3倍になりますか?
いいえ。すべてのキーはアカウント単位の同じ1日クォータと1分あたりの制限を共有します。
失くしたシークレットを確認できますか?
できません。平文のキーは保存されていないため、キーを再生成して新しいシークレットを保存してください。
有料プランが期限切れになるとどうなりますか?
サイトのアカウントに対象となる有効なプランがなくなるとAPIアクセスは無効になります。PremiumまたはProを更新すると対象APIアクセスを再開できます。
FileConvertFreeを連携しますか?
ダッシュボードからキーを作成し、usageエンドポイントで確認してから、アプリに必要な変換ルートを接続してください。