コードサイニング証明書をオーダーする

POST

https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}

This page describes products with the code_signing_certificate group name (see Glossary – Product identifiers).

Use this endpoint to submit a request to create an order for a code signing certificate. In the endpoint path, replace code_signing_certificate_id with the ID of the certificate you want to order. See Path parameters for allowed values.

Before you begin

Before using this endpoint, we recommend that you first create the organization and then submit the organization for validation. When submitting the organization for validation, use a validation object with a type value of cs in your request. Then, when you request your code signing certificate, use the existing organization ID instead of submitting new organization details with the request.

This ensures that you are using an existing organization with the proper validation type. Otherwise, the organization on the order will be outside the proper workflow for code signing validation, which may delay certificate issuance.

Industry moved to RSA 3072-bit key minimum for code signing certificates

To comply with industry changes, DigiCert has made the following changes to our code signing certificate process:

Only issues RSA 3072-bit key or larger code signing certificates*
Uses new intermediate CA and root certificates to issue our code signing and EV code signing certificates: RSA and ECC.

eToken and HSM changes

DigiCert supports two eTokens:

5110 CC for RSA 4096-bit and ECC P-256-bit key certificates
5110 FIPS for ECC P-256 and P-384-bit key certificates

HSM must:

Support ECC P-256 or RSA 3072-bit key sizes or larger
Be a FIPS 140-2 Level 2 or Common Criteria EAL4+ compliant device

*Note: All existing 2048-bit key code signing certificates issued before June 1, 2021 will remain active. You can continue to use these certificates to sign code until they expire.

Learn more about the change to 3072-bit key code signing certificates.

cURL

curl -X POST \
  'https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}' \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
  "certificate": {
    "server_platform": {
      "id": 52
    },
    "signature_hash": "sha256"
  },
  "cs_provisioning_method": "ship_token",
  "order_validity": {
    "years": 1 
  },
  "comments": "Message for the approver",
  "skip_approval": true,
  "organization": {
    "id": 123456
  },
  "ship_info": {
    "name": "Erin Guerra",
    "addr1": "360 Taylor Street",
    "addr2": "Floor 74",
    "city": "Richmond",
    "state": "va",
    "zip": "69662",
    "country": "us",
    "method": "EXPEDITED"
  },
  "auto_renew": 1,
  "custom_renewal_message": "Renew this please.",
  "custom_fields": [
    {
      "metadata_id": 12,
      "value": "123456"
    }
  ],
  "payment_method": "balance"
}'

Python

import requests

url = "https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}"

payload = "{\n  \"certificate\": {\n    \"server_platform\": {\n      \"id\": 52\n    },\n    \"signature_hash\": \"sha256\"\n  },\n  \"cs_provisioning_method\": \"ship_token\",\n  \"order_validity\": {\n    \"years\": 1\n  },\n  \"comments\": \"Message for the approver\",\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 123456\n  },\n  \"container\": {\n    \"id\": 654321\n  },\n  \"ship_info\": {\n    \"name\": \"Erin Guerra\",\n    \"addr1\": \"360 Taylor Street\",\n    \"addr2\": \"Floor 74\",\n    \"city\": \"Richmond\",\n    \"state\": \"va\",\n    \"zip\": \"69662\",\n    \"country\": \"us\",\n    \"method\": \"EXPEDITED\"\n  },\n  \"auto_renew\": 1,\n  \"custom_renewal_message\": \"Renew this please.\",\n  \"custom_fields\": [\n    {\n      \"metadata_id\": 12,\n      \"value\": \"123456\"\n    }\n  ],\n  \"payment_method\": \"balance\"\n}"
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("POST", url, data=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}"

	payload := strings.NewReader("{\n  \"certificate\": {\n    \"server_platform\": {\n      \"id\": 52\n    },\n    \"signature_hash\": \"sha256\"\n  },\n  \"cs_provisioning_method\": \"ship_token\",\n  \"order_validity\": {\n    \"years\": 1\n  },\n  \"comments\": \"Message for the approver\",\n  \"skip_approval\": true,\n  \"organization\": {\n    \"id\": 123456\n  },\n  \"container\": {\n    \"id\": 654321\n  },\n  \"ship_info\": {\n    \"name\": \"Erin Guerra\",\n    \"addr1\": \"360 Taylor Street\",\n    \"addr2\": \"Floor 74\",\n    \"city\": \"Richmond\",\n    \"state\": \"va\",\n    \"zip\": \"69662\",\n    \"country\": \"us\",\n    \"method\": \"EXPEDITED\"\n  },\n  \"auto_renew\": 1,\n  \"custom_renewal_message\": \"Renew this please.\",\n  \"custom_fields\": [\n    {\n      \"metadata_id\": 12,\n      \"value\": \"123456\"\n    }\n  ],\n  \"payment_method\": \"balance\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

NodeJS

var request = require("request");

var options = { method: 'POST',
  url: 'https://www.digicert.com/services/v2/order/certificate/{{code_signing_certificate_id}}',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' },
  body: 
   { certificate: 
      { server_platform: { id: 52 },
        signature_hash: 'sha256' },
     cs_provisioning_method: 'ship_token',
     order_validity: { years: 1 },
     comments: 'Message for the approver',
     skip_approval: true,
     organization: { id: 123456 },
     container: { id: 654321 },
     ship_info: 
      { name: 'Erin Guerra',
        addr1: '360 Taylor Street',
        addr2: 'Floor 74',
        city: 'Richmond',
        state: 'va',
        zip: '69662',
        country: 'us',
        method: 'EXPEDITED' },
     auto_renew: 1,
     custom_renewal_message: 'Renew this please.',
     custom_fields: [ { metadata_id: 12, value: '123456' } ],
     payment_method: 'balance' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

201 Created (one-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "pending"
        }
    ]
}

201 Created (two-step approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "submitted"
        }
    ]
}

201 Created (auto approval)

{
    "id": 112233,
    "requests": [
        {
            "id": 113,
            "status": "approved"
        }
    ],
    "certificate_id": 113
}

Path parameters

Name	Req/Opt	Description
code_signing_certificate_id	required	Product identifier of the code signing certificate you want to order. Allowed values: Code Signing: `code_signing` EV Code Signing: `code_signing_ev` For a list of all product identifiers, see Glossary - Product identifiers.

Request parameters

Parameters with an asterisk (*) are used only for EV code signing orders.

Name	Req/Opt	Type	Description
certificate	required	object	Certificate details.
.. csr	conditional	string	Certificate signing request (CSR). Required for EV Code Signing certificates that will be installed on HSMs. Required for Code Signing certificates if `server_platform.id` is `55` (Sun Java). CSRs for code signing certificates must be ECC P-256 or RSA 3072-bit key sizes or larger. To learn more about CSR requirements, see Glossary – CSR requirements. Note: The Services API does not extract information from the CSR to fill in the details of a certificate request. You must provide values for all relevant request parameters, including `organization.id`. If you are creating a new organization with your certificate request, you must provide values for all required parameters of the `organization` object.
.. signature_hash	required	string	Hash algorithm used to signing the certificate. Allowed values: `sha256`
.. server_platform	required^*	object	Server platform type. ^*Required if `cs_provisioning_method` is `client_app` or not provided.
.. .. id	required	int	Server platform ID. Allowed values: See Glossary - Code signing certificates. For EV code signing certificate orders, see Glossary - EV Code signing certificates.
.. organization_units	optional	array	Department in your organization associated with the certificate.
auto_renew	optional	int	Number of times the certificate should renew automatically.
additional_emails	optional	array	Additional email addresses to receive certificate notification emails (e.g., certificate issuance, duplicate certificate, certificate renewals, etc.).
renewal_of_order_id	optional	int	If order is a renewal, enter the previous order's ID.
skip_approval	optional	bool	Specify if the order should skip the certificate request approval step and be immediately submitted for validation and issued when complete. Default: `false`. The `skip_approval` option skips only the approval step (for example, from your organization), but does not skip the validation step required by Digicert for a certificate.
organization	required	object	Object with information about the organization to associate with the request. You can associate the request with an existing organization, or you can create a new organization when you submit the order request. To associate the request with an existing organization, pass the ID of the organization as the value of `organization.id` in the body of your request. To create a new organization, include the details of the organization in the `organization` object. For more information about the structure and required parameters of the `organization` object, see the Create organization documentation. Note: When you submit an order with organization details instead of providing an organization ID, we check the organizations that already exist in your account to avoid creating a duplicate. If we find one matching organization, we automatically associate the order with that organization instead of creating a new one. If we find two or more matching organizations, we automatically associate the order with the oldest matching organization in your account instead of creating a new one. To override this behavior and force the request to create a new organization, set the `organization.skip_duplicate_org_check` parameter to `true` in the body of your request. Important: When you want to associate an order with an existing organization, we recommend always using the ID of the organization instead of the organization's details in the body of your request. To get the ID values for organizations in your account, use the List organizations endpoint. Additionally, we recommend deactivating unused organizations to ensure they are never accidentally assigned to a new order request. To deactivate an organization, use the Deactivate organization endpoint.
.. id	required*	int	The ID of an existing organization to associate with the order. To get the ID of organizations in your account, use the List organizations endpoint. *Not required if you are creating a new organization with your request.
.. skip_duplicate_org_check	optional	bool	Use `true` to skip the check for duplicate organizations in your account. When you skip this check, you force the request to create a new organization, regardless of whether the details you provide in the request match the details of an organization that already exists in your account. Default: `false`
container	optional	object	If needed, specify the container the order should be placed under.
.. id	required	int	Container ID.
order_validity	required	object	Defines the validity period of the certificate and order.
.. years	required^*	int	Number of years the certificate and order are valid. ^Can be replaced by `order_validity.days` or `order_validity.custom_expiration_date`. Range*: `1`-`3`
.. days	optional	int	Number of days the certificate and order are valid. Overrides `order_validity.years`.
.. custom_expiration_date	optional	string	Custom expiration date for the certificate and order. Overrides `order_validity.days` and `order_validity.years`. Format: `dd MMM YYYY` (for example, `"09 JUN 2025"`)
validity_years	optional	int	Number of years the certificate and order are valid. Deprecated. Use the `order_validity` object to set the validity period of the certificate and order. Allowed values: `1` - `3`
custom_expiration_date	optional	string	Custom expiration date for the certificate and order. Deprecated. Use the `order_validity` object to set the validity period of the certificate and order. Overrides `validity_years` Format: `yyyy-MM-dd`
cs_provisioning_method*	required^*	string	For EV code signing certificates, specify how you want to receive the token. See Glossary – Provisioning methods ^*Required for EV code signing certificates.
ship_info*	optional	object	For EV code signing certificates, specify the shipping address for the token.
.. name	required	string	Name of the recipient.
.. addr1	required	string	Shipping address for the token.
.. addr2	optional	string
.. city	required	string	Shipping city.
.. state	required	string	Shipping state.
.. zip	required	string	Shipping postal code.
.. country	required	string	Shipping country.
.. method	required	string	Shipping priority for the token. Allowed values: `STANDARD`, `EXPEDITED` (incurs added cost)
custom_fields	optional*	object	Account-specific custom fields. *Whether or not these fields are required depends on your custom field settings.
.. metadata_id	required	int	Custom field ID.
.. value	required	string	Value for the custom field. Data validation type depends on your custom field settings.
payment_method	optional	string	Specify the payment method to use. Allowed values: `balance`, `card`, `profile` Default: `balance`
alternative_order_id	optional	string	A custom alphanumeric ID to assign the order. To see the `alternative_order_id` assigned to an order, use the Order info endpoint. Alternative order IDs do not replace the unique order ID that DigiCert assigns each order request. You cannot use alternative order IDs to search for or identify orders in API calls that require an `order_id` parameter in the URL path or request body. If the Require unique alternative order IDs option is enabled in your account settings, you cannot submit order requests with an alternative order ID that is already assigned to an order in your account. Use this feature to enable nonce order requests, or to prevent your integration from creating duplicate orders in cases where you do not receive a response from the API. Account administrators can toggle this option from the CertCentral console. From the Settings > Preferences page, open the Advanced Settings menu, and look for the Alternative order ID option. This parameter is always optional, even if the Require unique alternative order IDs option is enabled in your account. If a request does not use this parameter, no `alternative_order_id` value is assigned to the order. Maximum length: 64 characters Note: The Require unique alternative order IDs option may not appear in the advanced settings menu for all CertCentral accounts. To enable this option for your account, contact your account manager or our Support team.
enable_guest_access	optional	int	Whether to enable guest access for the order. This parameter is not allowed if guest access is disabled in your account settings. Allowed values: `1` (enabled) or `0` (disabled) Default: The default configuration for new orders is determined by your account settings. Account administrators can change these settings from the Guest Access page in the CertCentral console.

Response parameters

Name	Type	Description
id	int	Order ID.
organization	object	Container for new organization details. Only returned if a new organization was created with the order.
.. id	int	Organization ID for the new organization.
requests	array	Contains information about the request.
.. id	int	Request ID.
.. status	string	Request status. Possible values: `pending`, `submitted`, `approved`, `rejected`
certificate_id	int	Certificate ID. Returned if request status is `approved`.

Path parameters

Request parameters

Response parameters

案内