コンテンツにジャンプ
ご質問は?PaperOffice AI Phone Agent 24/7+49 69 3487102-0
概要 概要 ニュース ニュース
共有

認証とキー

ベアラートークン。 すべてのエンドポイントに。

PaperOffice-APIのすべての製品エンドポイントは、Authorization: Bearer ヘッダーを要求します。OAuthフローやリフレッシュは不要です。

2つのトークンタイプ、明確な権限、文書化されたレート制限。

1つのヘッダー OAuthフローなし いつでも取り消し可能
ベアラートークン。 すべてのエンドポイントに。
cURL
curl -X POST "https://api.paperoffice.ai/latest/job/add/workflow" \  -H "Authorization: Bearer po_ut_YOUR_API_KEY" \  -F "file_1=@invoice.pdf" \  -F "idp_collection=invoice" \  -F "model=basic-pro-max"

初回呼び出し

ヘッダーを設定、パイプラインを選択、送信

/latest/job/add/ の後のパスは操作名です。通常は handler___command 形式(例:paperoffice_aiocr___generate)であり、構造化された IDP の場合は専用の workflow パイプラインを使用します。

  • 1つのヘッダー

    Authorization: Bearer po_ut_… — 製品エンドポイントに必要なものはこれだけです。poai_ と po_ut_ は Origin ヘッダーを送信しません。

  • パス内のパイプライン

    handler___command に3つのアンダースコアを使用します。ワークフローは独自のスラグを持つ例外です。ドット表記は API に HTTP 400 JOB_CONFIG_INVALID で応答します。

  • 結果または job_id

    client_waitはデフォルトでtrueです:APIは接続を保持し、結果をインラインで返します。時間枠が足りない場合、HTTP 202がjob_idおよびpoll_urlと共に返され、GET /latest/job/get/{job_id}によるポーリングが可能になります。

idp_collection=invoiceの場合、推奨モデルはbasic-pro-maxです。実際に使用されるモデルはレスポンスフィールドのmodelで返され、リクエストされたものと異なる場合があります。

トークンタイプ

明確に分離された2つのトークンタイプ

両方ともサーバーに配置する必要があります。作成、ローテーション、取り消しは、アプリ内のアカウント → APIで行います。

poai_ サーバー間

APIキー

  • 作成したアカウントの権限(管理者:全アカウント)
  • ブラウザコードに決して提供しない
  • Originヘッダー不要
  • MCPでブロック済み
  • IPアドレスに制限可能
APIキーを管理
po_ut_ ユーザー関連

User Token

  • ユーザーの権限を付与します
  • ブラウザコードに決して提供しない
  • Originヘッダーは不要
  • MCP対応
ユーザートークンを作成

ブラウザからの直接呼び出しは、これらの2つのトークンではなく、Publishable Key po_pk_ を介して実行されます。これは発生源に依存し、予算とレート制限があります。 Publishable Keysを表示

権限

User Token が実行可能な操作

User Token は、指定された領域においてユーザーの権限を正確に反映します。作成時に特定の領域のみを選択して付与することはできません。範囲を制限する場合は、ユーザーグループの権限を持つグループトークン(po_gt_)を使用してください。

  • 文書 documents

    アップロード、ダウンロード、処理

  • Workspaces workspaces

    フォルダと構造の管理

  • AIジョブ ai_jobs

    OCR、IDP、抽出

  • 請求 billing

    利用状況と残高の確認

  • ユーザー users

    チームメンバーを管理する

  • ウェブフック webhooks

    イベントを受信する

  • ナレッジベース knowledge_base

    ナレッジベースとFAQ

  • エージェント agents

    IDPエージェントを設定

  • ワークフロー workflows

    自動化を作成

  • コンプライアンス compliance

    監査、GDPR、アーカイブ

レート制限

APIがカウントするもの

トークンごとにカウントされます。Bearerなしの場合はIPアドレスごとにカウントされます。以下の値は、すべてのプランで適用される文書化された最小値です。

5
秒あたりのリクエスト数
30
分あたりのリクエスト数
100
時間あたりのリクエスト数
500
日あたりのリクエスト数
  • 残量値はレスポンスヘッダーに含まれます

    各レスポンスのRateLimit-*およびX-RateLimit-*ヘッダーには、現在のウィンドウでまだ利用可能な残量が示されます。

  • 超過時の応答: HTTP 429

    APIはRATE_LIMIT_EXCEEDEDを返します。Retry-Afterヘッダーに記載された時間後にリクエストを再試行してください。

  • 上位プランでは制限値が引き上げられます

    有料プランはこれらの最低値を上回ります。どのプランにどの容量が含まれるかは、料金ページをご参照ください。

セキュリティ

キーを保護する要素

運用中に機能する6つのメカニズム — 各々に検証可能なステータスコードまたはアプリ内の場所があります。

  • ローテーションと取り消し

    キーはアプリ内の「アカウント → API」で作成、一覧表示、ローテーション、取り消しが行われます。取り消されたトークンは HTTP 401 TOKEN_NOT_FOUND を返します。

  • 有効期限と妥当性

    期限切れのトークンは HTTP 401 および BEARERTOKEN_EXPIRED を返し、不正なトークンは HTTP 401 および INVALID_TOKEN を返します。Publishable Keys は作成日から 180 日間有効です。

  • トークンごとの制限

    Freeプランでは、トークンごとにレート制限が適用されます。有料プランではアカウント単位でカウントされ、Creditsが存在する限り、レート制限は適用されません。

  • ブラウザでのオリジンバインディング

    Publishable Keys は各リクエストで Allowlist からの Origin を要求します。それ以外の場合、API は 403 ORIGIN_HEADER_REQUIRED または DOMAIN_NOT_ALLOWED で応答します。

  • 利用状況の追跡

    請求対象となる各レスポンスには_billingブロックが含まれます。呼び出しごとの評価にはGET /latest/billing/usage-detailを使用します。

  • 厳格なアクセス制限

    ブラウザキーに対して、アカウントログイン、キー管理、OAuth、パートナー管理者権限、支払い変更およびパスワードクラックはブロックされています。プロダクトAPIs(請求書読み取りおよびWebhooksを含む)は許可されています。Workspaceの削除、ゴミ箱の空欄化、法的管理解除はアプリ内でのみ実行可能です(403 UI_ONLY_ENDPOINT)。

始める

キーを作成し、ヘッダーを設定して送信する

キーはアプリの「アカウント」→「API」で設定します。最初の呼び出しの手順は動画でご確認ください。

PaperOffice AI · Problem Solver

私たちにお聞かせください、 日々の業務で時間を取られていること。

簡単にご記入ください。専門用語は不要です。

または、例から始めてみましょう

PaperOfficeはどのようにご利用になりますか。

PCとスマートフォンが接続されました:PCでワークスペース、電話で取得。

どこから始めますか?

フルワークスペースはPC用に最適化されています。モバイルバージョンは文書の取得、確認、共有に適しています。

無料で登録 app.paperoffice.ai

PCで開始する

パーソナルアクセスリンクをメールアドレスにお送りします。