PDF API が明らかにするもの — クレジットと制限
API ページは API よりも早く成長する傾向があります。現在、ブラウザなしで終了するルート (アカウント、編集、比較) のみがリストされています。それは意図的なものです。ワークフローを完了できないエンドポイントは、エンドポイントが存在しないよりも悪いです。
今日のライブは何ですか
- /v1/me を取得 — アカウント、プラン、および現在のクレジット残高。通話ごとに 1 クレジット。
- POST /v1/redact-pdf — パターン、テキスト、または画像を検索し、編集された PDF を返します。
apply=1。無料。 - POST /v1/compare-pdf — 統計、変更されたブロック、および 2 つの PDF 間の主な違い。無料。
3 つすべてが My Account から無記名キーを取得します。結果は、2 時間存続するダウンロード リンクを含む JSON です。オリジナルがそのまま変更されることはありません。
APIにないもの
今日の API の料金
存在するルートは次の 3 つだけです。 GET /v1/me 1クレジットかかりますが、 POST /v1/redact-pdf そして POST /v1/compare-pdf それぞれ5クレジットかかります。これらのツールは API エンドポイントではないため、マージまたは OCR API の料金は発生しません。ライブ料金は プランと料金 ページ。
電子署名者がルートではない理由
署名はブラウザーのワークフローを 2 回繰り返します。送信者はページにフィールドを配置し、受信者はリンクを開いて署名します。 HTTP クライアントはレイアウトを確認したり、そのページを操作したりできないため、「電子署名 API」はジョブが完了する前に停止します。エンベロープは電子署名ダッシュボードにあります。 API はそれらを作成したり署名したりしません。
キーとファイルの保持
API キーをパスワードのように扱います。アプリケーションごとに 1 つのキーを使用し、パブリック リポジトリに貼り付けられている場合はローテーションし、ブラウザ側の JavaScript には決して入れないでください。アップロードされたファイルは、推測不可能な ID を持つ一時的な作業コピーです。これらはドキュメントストアではありません。オリジナルを独自のストレージに保存し、API 応答を派生コピーとして扱います。の セキュリティページ に、コントロールと保持期間のリストを示します。
アップグレード前に測定すべきこと
成功した通話、失敗した通話、最後のクレジット残高という 3 つの数値を 1 か月間追跡します。編集と比較は有料 (それぞれ 5 クレジット) なので、忙しい月は残高に表示されます。アカウント呼び出しコスト 1。再試行またはピーク月のスパイクによってクレジットが消費される場合は、失敗したバッチよりも大規模なプランの方が安価です。未使用のクレジットは繰り越されるため、静かな月が無駄になることはありません。
電子署名はブラウザのみで使用できます。 誰かが受信者の署名フィールドを視覚的に配置する必要があり、受信者は署名ページを開いて署名する必要があります。 HTTP クライアントはどちらも実行できないため、エンベロープの作成、署名、リスト、ポーリングを行うための API ルートはありません。 E-Signer ダッシュボードは引き続きその作業に適した場所です。
同じテストでは、マージ、圧縮、変換、およびエディターを現時点では API から削除しています。これらの便利なワークフローは対話型で、ファイルを大量に使用します。これらは、中途半端に動作するエンドポイントとして宣伝されるのではなく、ブラウザー内で無料のままです。
クレジットで買えるもの
クレジットは、商用アカウントに関連付けられた前払い残高です。現在、有料の API ルートは次のとおりです。 GET /v1/me 1 クレジット、墨消しと比較はそれぞれ 5 クレジットです。プランには毎月のクレジット枠が引き続き含まれており、未使用のクレジットは期限切れになるのではなく繰り越されます。ライブ API レートを以下にリストします。 プランと料金 ページに記載されており、存在しないルートのツールごとの価格は公開されません。
キー、制限、安全性
API キーは 1 回表示され、ハッシュとしてのみ保存されます。取り消されたキーはすぐに機能しなくなります。キーごとおよび IP ごとのレート制限の回答 429 と Retry-After、アップロードにはサイズとページ数によって制限があり、禁止されたアカウントまたは資格のないアカウントはライブ キーを使用できません。の APIページ 3 つのルートとそのリクエスト フィールドを文書化します。
はじめに
アカウントを作成し、API キーが必要な場合は商用プランをアクティブ化し、マイ アカウントでキーを作成して呼び出します。 GET /v1/me まず。ブラウザ ツールでその仕事ができる場合は、ブラウザ ツールを使用してください。ブラウザ ツールは無料のままです。