メインコンテンツへスキップ

API

API の基本概念

認証、非同期タスク、ドキュメント変換 API のライフサイクルを理解します。

PDF Craft API は REST ベースで、JSON 形式のリクエストとレスポンスを使用し、Bearer API キーで各リクエストを認証します。

ベース URL と認証

すべてのエンドポイントは https://fusion-api.oomol.com/v1 配下にあります。API キーは Authorization リクエストヘッダーで送信してください。

text
Authorization: Bearer YOUR_API_KEY

このキーをフロントエンドのコードに公開しないでください。エンドユーザーが変換を開始する場合は、ブラウザーからのリクエストを自社のバックエンド経由で処理してください。

非同期タスクのライフサイクル

ドキュメント変換は非同期で実行されます。送信エンドポイントはタスク識別子 sessionID を返し、対応する結果エンドポイントは次のいずれかの状態を返します。

  • processing:ファイルは待機中、または変換中です。
  • completed:結果には data.downloadURL に生成された出力の URL と、そのメタデータが含まれます。
  • failed:結果には失敗の理由が含まれます。アプリケーションで表示または記録してください。

タスクが最終状態になったらポーリングを停止し、再試行回数を制限してください。サポートや復旧に備えてタスク ID を保持してください。

エンドポイント

現在の API は PDF から Markdown および EPUB への変換をサポートしています。エンドポイントのパス、パラメーター、ペイロードの例、Python SDK と TypeScript SDK の使用方法については、完全な API リファレンス を参照してください。