CertCentral Services API: Improved Order info API response
Update: To give API consumers more time to evaluate the impact of the Order info API response changes on their integrations, we are postponing this update until May 31, 2022. We originally planned to release the changes described below on April 25, 2022.
On May 31, 2022, DigiCert will make the following improvements to the Order info API. These changes remove unused values and update the data structure of the order details object to be more consistent for orders in different states across product types.
For more information and response examples for public TLS, code signing, document signing, and Class 1 S/MIME certificates, see the reference documentation for the Order info endpoint.
If you have questions or need help with these changes, contact your account representative or DigiCert Support.
Need to test your API integration?
To help CertCentral Services API consumers evaluate the impact of these changes, DigiCert is providing a beta server for API consumers to test their integrations prior to the May 31, 2022 release. To learn more, see our knowledge base article: DigiCert CertCentral Services API beta server.
The following changes apply to orders for various certificate types irrespective of order status.
public_idparameter. DigiCert no longer supports the Express Install workflow that required a
ca_cert_idparameter. The value of this parameter is an internal ID for the issuing ICA certificate and cannot be used externally. The API already excludes the
ca_cert_idparameter from the order details for other product types.
verified_contacts(array of objects)
verified_contactsarray. The API already excludes the
verified_contactsarray from the order details for other product types.
certificate.dns_names(array of strings)
dns_namesarray with an empty string:
certificate.organization_units(array of strings)
organization_unitsarray with an empty string:
cert_validityobject, the API will only return a key/value pair for the unit used to set the certificate validity period when the order was created. For example, if the validity period of the certificate is for 1 year, the
cert_validityobject will return a
yearsparameter with a value of 1.
cert_validityobject sometimes returned values for both
order_validityobject returns the
custom_expiration_datefor the order validity period. The API already includes an
order_validityobject in the order details for public SSL/TLS products.
payment_profileobject. The API already includes a
payment_profileobject in the order details for other product types.
server_licensesFor DV certificate orders, the API will start returning the
server_licensesparameter. The API already includes the
server_licensesparameter in the order details for other product types.
Unapproved order requests
The following changes apply only to certificate order requests that are pending approval or that have been rejected. These changes bring the data structure of the response closer to what the API returns after the request is approved and the order is submitted to DigiCert for validation and issuance.
To manage unapproved and rejected requests, we recommend using the Request endpoints (
/request) instead of retrieving the order details. We designed the
/request endpoints to manage pending and rejected certificate order requests, and these endpoints remain unchanged.
Note: For quicker certificate issuance, we recommend using a workflow that skips or omits the request approval step for new certificate orders. If your API workflow already skips or omits the approval step, you can safely ignore the changes below. Learn more about removing the approval step:
server_licensesparameter. The API will continue including the
server_licensesparameter in order details for approved order requests.
To provide a consistent data structure in the order details for unapproved and approved order requests, the API will return a modified
organization object on unapproved order requests for some product types.
The API will stop returning the following unexpected properties on unapproved order requests for all product types:
organization.contacts(array of objects)
The API will start returning the following expected properties, if existing, on unapproved order requests for all product types:
To get organization details not included in the Order info response, use the Organization info API endpoint.
Corrigimos um erro de re-emissão do certificado DV em que não honrávamos a data de validade no pedido original para certificados com mais de um ano restante até expirarem.
Agora, ao re-emitir um certificado DV com mais de um ano restante até sua expiração, o certificado reemitido reterá a data de validade do certificado original.
Na API de serviços da DigiCert, aprimoramos os pontos de extremidade da solicitação de certificados DV, permitindo o uso do novo campo
email_domain junto com o campo
Por exemplo, ao pedir um certificado para meu.exemplo.com, é possível fazer com que um dono do domínio para o domínio base (exemplo.com) valide o subdomínio. Para alterar o destinatário do e-mail para o e-mail DCV, na sua solicitação de certificado DV, adicione o parâmetro dcv_emails. Depois, adicione o campo
email_domain especificando o domínio base (exemplo.com) e o campo
Pontos de extremidade do certificado DV: