API ドキュメント

概要

Orbitex API を使うと、圧縮、結合、分割、変換の処理を自分のアプリケーション、スクリプト、CI パイプラインに組み込めます。すべてのリクエストは HTTPS を使い、API キーが必要です。

API は開発中です。エンドポイント、レート制限、認証の詳細は、公開ベータの前にここに掲載します。

認証

リクエストには API キーを含む Authorization ヘッダーを付けます。

• キーは Orbitex のダッシュボードで作成します (ビジネスプラン)。
• キーが漏れた場合はダッシュボードから入れ替えてください。
• クライアント側の JavaScript や公開リポジトリにキーを置かないでください。

予定しているエンドポイント

最初の API では次を提供する予定です。

• POST /v1/pdf/compress - PDF のファイルサイズを小さくする
• POST /v1/pdf/merge - 複数の PDF をまとめる
• POST /v1/pdf/split - ページまたは範囲で分割する
• POST /v1/pdf/convert - PDF と Word、Excel の相互変換
• POST /v1/pdf/protect - パスワードで暗号化する
• GET /v1/jobs/{id} - 非同期処理の状態を確認する

ファイルの取り扱い

アップロードされたファイルには、Web 画面と同じセキュリティと削除の規則が適用されます。保存期間と暗号化の詳細は、ファイルのセキュリティ方針をご覧ください。

時間のかかる処理が終わると、Webhook がお客様のサーバーに通知します。

レート制限

レート制限はプランによって変わります。無料プランでの API 提供は予定していません。ビジネスのお客様には、文書化された制限と一時的な超過の余裕を用意します。

先行アクセスを得る

一括変換、文書処理の自動化、SaaS への組み込みなど、用途をお知らせください。ベータが始まったらご連絡します。