2022年4月26日(火)午前1時(日本時間)よりAPIにおけるレスポンスのパラメータの一部削除、または変更いたします。 これらの変更により、未使用の値が削除され、オーダーの詳細オブジェクトのデータ構造の向上を目的とし、全製品において(承認待ち、キャンセル等のステータスを問わず)より一貫したレスポンスに統一いたします。
パブリックTLS、コードサイニング証明書、ドキュメントサイニング証明書、およびClass 1 S/MIME証明書の詳細とレスポンスについては、オーダー情報をご参照ください。
1.これらの変更は、オーダーステータスに関係なく、さまざまな証明書タイプの申請に適用されます。
1-1.使用停止となるパラメータについて
すべての申請においてAPIはpublic_idパラメーターのリターンを停止いたします。デジサートでは、public_id値を必要とするExpressInstallworkflowのサポートも停止いたします。
証明書にチェーンする中間CA証明書の名称と公開IDを取得するには、ca_certオブジェクトを使用してください。
ドキュメントサイニング証明書においてAPIはverified_contacts配列のリターンを停止します。APIは、他の製品の詳細からもverified_contacts配列をすでに除外しています。
申請に紐づいたDNS名が存在しない場合(例:コードサイニング証明書、ドキュメントサイニング証明書、またはClass 1 S / MIME証明書)、APIはdns_names配列のリターンを停止します。
変更前は、APIはこちらの配列で空のレスポンスをリターンしていました。dns_names:[""]
申請に紐づくOU(Organizational Unit)が存在しない場合、APIはorganization_units配列のリターンを停止します。
(一部の製品タイプにおいて)変更前は、APIはこちらの配列で空のレスポンスをリターンしていましたorganization_units:[""]。
cert_validityオブジェクトにおいて、APIは、オーダーが送信された際、証明書の有効期間を設定するために使用されたユニットのkey/valueのペアのみを返します。たとえば、証明書の有効期間が1年間の場合、cert_validityオブジェクト値1のyearsパラメーターを返します。
変更前は、cert_validityオブジェクトが日にち(days)と年(year)の両方の値をリターンしていました。
1.2. 追加されるパラメータについて
コードサイニング証明書、ドキュメントサイニング証明書、およびクライアント証明書の申請の場合、APIはorder_validityオブジェクトのリターンを開始します。order_validityオブジェクトは、オーダーの有効期限の日、年、またはcustom_expiration_dateを返します。APIは、パブリックSSL/TLS製品のオーダー詳細にorder_validityオブジェクトがすでに含まれています。
DV証明書オーダーの場合、予めアカウントに保存されたクレジットカードが使用された場合、APIはpayment_profileオブジェクトのリターンを開始します。APIには、他の製品タイプの注文詳細に、payment_profileオブジェクトがすでに含まれています。
DV証明書オーダーの場合、APIはserver_licensesパラメータのリターンを開始します。APIには、他の製品タイプの注文詳細にserver_licensesパラメーターがすでに含まれています。
2. 承認待ちのリクエストについて
下記の変更は、承認待ちまたはキャンセルれた証明書注文リクエストにのみ適用されます。これらの変更により、レスポンスのデータ構造は、リクエストが承認され、申請がDigiCertに送られ、認証および発行された後にAPIが返すものに統一されます。
なお、承認待ちまたはキャンセルされたリクエストを管理するには、申請の詳細を取得するのではなく、リクエストエンドポイントに(/request)を使用することをお勧めします。
注意)証明書を迅速に発行するために、新しい証明書注文のリクエスト承認ステップをスキップまたは省略するワークフローを使用することをお勧めします。承認ステップの削除についてはこちらをご覧ください。
ベストプラクティス https://dev.digicert.com/ja/best-practices/
証明書オーダープロセスから承認ステップを削除する
2.1. 削除されるパラメータ
承認待ちのリクエストに対して、APIはserver_licensesパラメータのリターンを停止いたします。承認されたリクエストについては、引き続きserver_licensesパラメータをリクエストの詳細情報に含みます。
2.2. 追加されるパラメータ
3. 下記の変更は、承認待ちの一部または全ての製品タイプにおけるリクエストに適用される、組織オブジェクトの変更となります。
承認待ちおよび承認済みのリクエストの詳細に一貫したデータ構造を提供する目的で、今後APIは、一部の製品タイプの承認待ちのリクエストに対して以下のとおり変更された組織オブジェクトを返します。 オーダー情報のレスポンスに含まれていない組織の詳細を取得するには、組織情報のAPIエンドポイントを使用してください。
3.1. 削除されるプロパティ
APIは、すべての製品タイプの承認待ちのリクエストに対して、以下のプロパティのリターンを停止します。
3.2. 追加されるプロパティ
APIは、すべての製品タイプの承認待ちのリクエストに対して、以下のプロパティをリターンいたします。
本件に関するお問合せ先はこちら