Certyneo Postmanコレクションをなぜ使用するのか
このコレクションは、最初のリクエストを開始する前にすべてのドキュメントを読むことなくCertyneo APIを探索したい開発者向けに設計されています。
すぐに使用できるリクエスト
REST API v1の各エンドポイントは、APIキーを入力した後すぐに実行可能な、リクエストとレスポンスの例を含めて文書化されています。
テスト環境
Postman環境変数にはAPIキーとベースURLが含まれており、アカウントまたは環境間で簡単に切り替えることができます。
自動生成ドキュメント
Certyneo API のコレクションPostmanドキュメントは OpenAPI仕様と同期しており、テスト環境と本番環境間の相違はありません。
コードを書かずにテスト
エンベロープを作成し、送信して、APIをアプリケーションに統合する前に、Postmanインターフェースから直接ステータスを追跡できます。
コレクションでカバーされている内容
公開コレクションで利用可能なエンドポイントグループの概要です。
| グループ | 含まれる内容 |
|---|---|
| エンベロープ | 署名エンベロープの作成、送信、リスト表示、確認、およびキャンセル。 |
| ドキュメント | ドキュメントをアップロードまたはURL(sourceUrl)からインポートし、ステータスを確認します。 |
| 署名者 | 受取人を追加し、署名順序とレベル(SES/AES)を定義します。 |
| Webhooks | 署名イベントのサブスクリプションを作成および管理します。 |
| 一括送信 | 大量署名キャンペーン用に、複数のエンベロープを単一のリクエストで送信します。 |
このコレクションは読み取り専用でパブリックです。アカウントなしで閲覧できますが、リクエストの実行には有効な Certyneo API キーが必要です。
4つのステップでコレクションを始める
最初のリクエストを送信するまで5分未満です。
- 1
パブリックコレクションをインポートする
Postman から Certyneo パブリックコレクションを開き、「Fork」または「Import」をクリックして自分のワークスペースにコピーします。
- 2
Certyneo API キーを生成する
Certyneo ダッシュボードで「設定」→「API キー」を開き、Postman 用の専用キーを作成します。
- 3
環境変数を設定する
API キーを Postman コレクションの環境変数に貼り付け、同時に API のベース URL も入力します。
- 4
最初のリクエストを送信する
「エンベロープを作成」リクエストを実行し、Postman で直接結果を確認します。
セキュリティとベストプラクティス
このコレクションのリクエストは、本番環境のアプリケーションと同じ API を経由します。同じセキュリティ規則が適用されます。
- すべてのリクエストは HTTPS/TLS 1.2 以上で転送されます。
- 各 API キーは、作成時に付与されたアクセス権限に制限されます。
- Postman テスト用に本番環境のキーとは別の専用テストキーを使用してください。
- 漏洩または未使用の API キーは、Certyneo ダッシュボードからワンクリックで無効化できます。
よくある質問
Postman コレクションを使用するために有料プランが必要ですか?
いいえ。コレクションはパブリックであり、無料です。Certyneo プランの制限(エンベロープ数、機能)は、API の他の使用方法と同様に、実行されたリクエストに適用されます。
APIキーはどこで見つけることができますか?
Certyneo ダッシュボードの「設定」→「API キー」から確認できます。Postman テスト用に専用キーを作成してください。
コレクションは API の最新バージョンに対応していますか?
はい、コレクションは Certyneo API REST v1 の公式 OpenAPI 仕様から再生成されており、API が更新されるたびに最新の状態に保たれています。
Postman からウェブフック をテストできますか?
はい、コレクションにはウェブフック サブスクリプションを作成・一覧表示するエンドポイントが含まれています。ローカルでイベントを受信するには、テスト期間中に HTTP トンネル サービスを使用してください。
Postman コレクションの使用にコストはかかりますか?
いいえ、API 自体の使用(エンベロープの作成)のみがプランから差し引かれ、通常の API 呼び出しと全く同じです。
更に進めるために
Postman で Certyneo API をテストする
パブリック、無料、開発者ドキュメントと同期されたコレクション。