Knowledge Base
CertCentral Services API ご利用手順
CertCentral Services API ご利用手順
CertCentral Services API は、CertCentral の証明書ライフサイクル管理を外部システムから実施するための REST API です。
本ページでは、CertCentral Services API の概要、利用開始までの流れ、APIキーの作成、基本的なリクエスト方法、運用上の注意点を説明します。
| 本ページに掲載している画面名称や提供機能は、契約内容、権限、製品更新状況により一部異なる場合があります。また、画面キャプチャおよび画像は、操作手順を説明するためのサンプルです。ご利用環境、アカウント設定、製品仕様の変更等により、実際の画面表示、メニュー名、項目名、配置が本ページの記載と異なる場合があります。実際に操作される際は、CertCentral 上に表示される最新の画面内容をご確認のうえ、本ページを参考資料としてご活用ください。 |
目次
- 概要
- 利用開始までの流れ
- 利用前の確認事項
- APIキーの作成と認証
- APIリクエストの基本
- APIで実施できる主な操作
- 画面操作や ACME との違い
- 運用上の注意点とトラブルシューティング
- 関連サイト
1. 概要
CertCentral Services API は、契約種別にかかわらず、CertCentral の各種操作を外部システムから実施するための API です。社内ポータル、申請ワークフロー、運用ツール、証明書管理基盤などと連携し、証明書ライフサイクル管理を効率化する用途に適しています。利用できる API、証明書製品、認証フロー、承認フローは、契約内容、アカウント設定、ユーザー権限、対象製品により異なる場合があります。
主な利用例
|
各エンドポイントの詳細、必須パラメータ、リクエスト／レスポンス形式、サンプルコードについては、以下のドキュメントをご確認ください。
2. 利用開始までの流れ
CertCentral Services API を利用する際は、まずアカウント、ユーザー、権限、認証状態を整理したうえで、限定的な疎通確認から開始することを推奨します。
- CertCentral Services API が利用可能なCertCentral アカウントの契約であること
- APIを利用するユーザーまたはサービスユーザーを確認する
- 必要な権限が付与されていることを確認する
- APIキーを作成する
- 接続元 IP 制限や権限制限の要否を確認する
- 利用予定 API の仕様を DigiCert Developer documentation で確認する
- 本番影響の少ない範囲で疎通確認を行う
- 本番運用に組み込む
3. 利用前の確認事項
APIを利用する前に、以下の項目を確認してください。
未確認の項目がある場合、申請エラー、認証待ち、権限不足、支払い方法エラーなどが発生する可能性があります。
- CertCentral Services API が利用可能なCertCentral アカウントを保有していること
- 対象アカウントで利用予定の証明書製品が有効であること
- 申請対象が OV、EV、DV のいずれの証明書であるかを確認していること
- API を利用するユーザーまたはサービスユーザーが用意されていること
- API キーを作成できる権限があること
- API で実施する操作に必要な権限が付与されていること
- 申請対象の組織情報が CertCentral 上に登録されていること（※OV/EV 証明書など、組織情報が必要な製品の場合）
- 申請対象のドメインが CertCentral 上に登録されていること
- 対象製品で必要となる DCV、組織認証、発行承認などの認証フローを確認していること
- 事前認証を利用する運用か、申請ごとに認証を行う運用かを確認していること
- 支払い方法、承認フロー、申請可能製品を確認していること
4. APIキーの作成と認証
CertCentral Services API では、APIキーを用いて認証を行います。CertCentral にサインインし、［自動化］＞［APIキー］ から作成します。APIキーは、CertCentralユーザーまたはサービスユーザーに関連付けて発行できます。
サービスユーザーは API 利用を主目的としたユーザーであり、社内システム、管理ポータル、バッチ処理、CI/CD 環境などから継続的に API を呼び出す場合に適しています。
APIキー作成時は、用途に応じて権限を制限できます。代表例は以下のとおりです。
- Orders
- Orders, Domains, Organizations
- View Only
- User Management
- Domains
| 重要: APIキーは作成時に一度だけ表示されます。後から再表示することはできません。紛失した場合は既存キーを失効し、新しいキーを作成してください。また、APIキーは秘密情報として管理し、メール本文、チャット、共有フォルダなどで平文共有しないでください。必要最小限の権限で運用することを推奨します。 |
認証方法の詳細は以下をご参照ください。
5. APIリクエストの基本
CertCentral Services API では、APIリクエスト時に HTTP ヘッダー X-DC-DEVKEY を指定します。
APIリクエストの Base URL は、以下を使用します。
https://www.digicert.com/services/v2
主に利用される HTTPメソッドは以下のとおりです。
GETPOSTPUTDELETE
リクエスト形式は、利用するエンドポイントにより異なります。多くの API では、JSON または XML 形式のリクエストを使用します。具体的なエンドポイント、必須項目、任意項目、APIレスポンス内容については、DigiCert Developer documentation の各 API ページをご確認ください。
6. APIで実施できる主な操作
CertCentral Services API では、主に以下の操作を実施できます。
- アカウント情報の取得
- ユーザー情報、サービスユーザー情報の取得
- 組織情報の作成、取得、更新
- ドメイン情報の作成、取得、更新
- DCV方式の確認、変更、認証状況の確認
- OV/EV/DV SSL/TLSサーバ証明書の新規申請
- 証明書の更新申請
- 証明書の再発行申請
- オーダー情報の取得
- リクエスト情報の取得
- 発行済み証明書のダウンロード
- 証明書チェーンの取得
- 証明書の失効申請
- レポート情報の取得
- Webhooksの設定
利用できるAPIや実施可能な操作は、契約内容、アカウント設定、ユーザー権限、対象製品により異なる場合があります。証明書申請を行う場合は、事前に以下の情報を整理しておくと実装を進めやすくなります。
- 製品名または製品ID
- 申請対象がOV、EV、DVのいずれであるか
- コモンネーム
- SANs
- CSR
- 組織情報
- ドメイン情報
- DCV方式
- 証明書の有効期間
- 支払い方法
- 発行承認の要否
- 通知先メールアドレス
- 申請後の証明書取得方法
- 事前認証を利用するか、申請ごとに認証を行うか
組織やドメインが事前に認証済みの場合、申請後の認証作業を短縮できる場合があります。認証が未完了の場合は、申請送信後、認証完了後に証明書が発行されます。
- OV/EV SSL/TLS証明書では、通常、組織認証とDCVが必要です。
- EV証明書では、認証済連絡先による発行承認が必要です。
- DV SSL/TLS証明書では、通常、組織認証は不要ですが、DCVが必要です。
主要 API ドキュメントへのリンク
7. 画面操作や ACME との違い
CertCentral の画面操作、Services API、ACME は、いずれも証明書管理に利用できますが、適した用途が異なります。
| 方法 | 特徴 | 向いているケース |
|---|---|---|
| CertCentral 画面操作 | ブラウザから申請、更新、再発行、ダウンロード、認証状況確認を手動で行う | 少数証明書の運用、個別対応、手動管理 |
| Services API | 外部システムから CertCentral の機能を呼び出し、業務フローや管理基盤と連携できる | 社内システム連携、自動化、レポート処理、統合管理 |
| ACME | ACME クライアントを利用して申請、更新、再発行を自動化する | ACME 対応ツールによる継続的な証明書運用 |
ACME クライアントを利用する場合は、Services API ではなく ACME 向けドキュメントを参照してください。
Third-party ACME client integration
CertCentral 画面での申請、更新、再発行などの基本操作については、以下をご確認ください。
CertCentral操作マニュアル - SSL/TLSサーバ証明書
8. 運用上の注意点とトラブルシューティング
API を安全かつ安定して運用するため、秘密情報管理、権限設計、事前検証、APIレスポンス変化への耐性を意識してください。
- APIキーは秘密情報として管理する
- APIキーは必要最小限の権限で作成する
- 不要になった APIキーは失効する
- 担当者変更時は APIキーとサービスユーザーを見直す
- 可能であれば個人ユーザーではなくサービスユーザーを利用する
- 接続元を限定できる場合は IP 制限を検討する
- 本番前に対象製品、支払い方法、承認フロー、認証状態を確認する
- 認証未完了や承認待ちにより即時発行されない場合があることを前提に設計する
- API 仕様更新を踏まえ、最新ドキュメントを実装時に確認する
| APIレスポンスに新しい項目が追加される場合があります。実装時は、未使用項目の追加で処理が失敗しない設計にしてください。 |
エラー発生時は、まず以下を確認してください。
- APIキーが有効であること
X-DC-DEVKEYヘッダーに APIキーを指定していること- APIキーに必要な権限が付与されていること
- 接続元 IP が制限でブロックされていないこと
- Base URL が正しいこと
- HTTPメソッドが正しいこと
- リクエスト形式が API 仕様と一致していること
- 必須パラメータが不足していないこと
- 製品 ID、組織 ID、ドメイン ID、オーダー ID が正しいこと
- 対象製品がアカウントで利用可能であること
- 組織認証、DCV、発行承認が完了していること
- 支払い方法やアカウント状態に問題がないこと
- APIレスポンスのエラーコードとメッセージを確認していること
サポート調査を依頼する場合は、以下の情報を整理するとスムーズです。
- CertCentral アカウント番号
- 実行した API のエンドポイント
- HTTPメソッド
- 発生日時
- 対象のオーダー番号またはリクエスト ID
- エラーメッセージ
- レスポンスコード
- APIキーそのものを除いたリクエスト内容
- APIキーそのものを除いたAPIレスポンス内容
| 注記：APIキー、秘密鍵、パスワード、トークンなどの秘密情報は送付しないでください。 |
9. 関連サイト
-
法人向けTLS/SSLサーバ証明書、PKI、IoT、署名ソリューションを提供するグローバルリーディングカンパニーです。
-
-
© 2022-2026, DigiCert, Inc. All rights reserved.
Cookie Settings
