クライアント SDKs
TypeScript、Python、および .NET クライアントは、API の動作と並行して維持されます。つまり、型指定されたリクエスト モデル、バージョン管理された更新、およびハンドロールされた HTTP はありません。
利用可能なクライアントSDKs
| 言語 | パッケージ名 | ステータス | ランタイム |
|---|---|---|---|
| TypeScript/Node.js | @esignature-erp/sdk | ✅ ライブ | ノード ≥ 20; 「fetch」によるブラウザバンドル |
| パイソン | 承認済み SDK | ✅ ライブ | Python ≥ 3.10 |
| .NET/C # | Endorsed.Sdk | ✅ ライブ | .NET 8以降 |
すべての SDKs は同じ方法 (ベアラー API キー) で認証され、同じバージョンのリクエスト/レスポンスコントラクトを共有します。 TypeScript クライアントは「packages/sdk」で作成されます。 Python と .NET のクイックスタートは、サンドボックスに同梱されている SDK クイックスタート ドキュメントに含まれています。
すべての SDK があなたに与えるもの
型指定されたリクエストとレスポンスのモデル
文字列で入力された辞書へのアクセスはありません。すべての API リソースには、IDE オートコンプリートとコンパイル時チェックを備えた型付きクラスがあります。
自動再試行
ネットワーク エラーと一時的な 5xx 応答は、指数バックオフで再試行されます。構成可能な最大試行とバックオフ キャップ。
ベアラー認証
API キーをクライアント構築時に一度渡します。 SDK は、すべてのリクエストの Authorization ヘッダーを処理します。
相関IDの伝播
すべての SDK 呼び出しは、応答から X-Correlation-ID を返します。サポートのトレーサビリティのために記録します。
よくある質問
SDK クイックスタート — 30 行未満のエンベロープ
入力されたクライアントをインストールし、資格情報を構成して、最初のエンベロープを送信します。 SDK は REST API に 1:1 でマッピングされます。つまり、同じ形状、同じエラー、同じバージョンです。
1 回の呼び出しで SDK 認証情報を取得します
`mode: Sandbox` でサンドボックスを要求します — 応答本文には、公開されたすべての SDK で即座に動作するスコープ付き API キーが含まれます。