1. Introduction
  2. Order Management
  3. Sample Code
  4. Errors and Troubleshooting
  5. Appendix
  6. Print-Friendly Documentation

Order Management - Order a Wifi Certificate

Request Endpoint

MethodURL
POSThttps://api.digicert.com/order/wfa

Request Parameters

Parameters are encoded in one of the content types that is accepted by the endpoint.

Parameter NameReq/OptAllowed ValuesDefaultDescription
csrRequired[string]Certificate Signing Request. To create a CSR from your server, visit DigiCert's website at https://www.digicert.com/csr-creation.htm for details.
validityRequired1, 2, 3Certificate validity length in years. For EV certificates, only 1 and 2 year lengths are allowed.
common_nameOptional[string][decoded from CSR]The name to be secured in the certificate. A sample common name: example.com
sansOptional[string][decoded from CSR]Subject Alternative Names. A comma delimited list of names to be secured in the certificate. Adding SANs names incurs additional cost.
server_typeOptionalsee Server Types-1Server platform. Defaults to Other.
org_unitOptional[string][blank]This is the OU field to be included in the certificate.
org_nameRequired[string]Name of organization which owns common name.
org_addr1Required[string]Address line 1 of the organization's address.
org_addr2Optional[string][blank]Address line 2 of the organization's address.
org_cityRequired[string]City of organization's address.
org_stateRequired[string]State / Province of the organization's address.
org_zipRequired[string]Zip or Postal code of the organization's address.
org_countryRequiredsee Country CodesA two character, lowercase abbreviation for country.
telephoneOptional**[numeric string][blank]Main telephone number of the organization.
org_contact_job_titleOptional**[string][blank]Title of contact working at the organization.
org_contact_firstnameRequired[string]First name of the organization contact.
org_contact_lastnameRequired[string]Last name of the organization contact.
org_contact_emailRequired[email address]Email address of the organization contact.
org_contact_telephoneRequired[numeric string]Telephone number of the organization contact.
org_contact_telephone_extOptional[numeric string][blank]Extension number of the organization contact.
default_logo_urlRequired[string]The URL of a publicly-accessible logo PNG, JPG, or GIF image to be included in this certificate. Changing the image after requesting the certificate will result in a broken certificate.
additional_logosOptional[collection]A set of additional logos for different languages.
languageRequiredSee ISO 639-2 LanguagesA valid ISO 639-2 language code.
urlRequired[string]See description for default_logo_url.
friendly_namesRequired[collection]A set of friendly names for different languages. At least one friendly name is required.
languageRequiredSee ISO 639-2 LanguagesA valid ISO 639-2 language code.
textRequired[string]A language-specific friendly name for this wifi certificate.

Response

Parameter NameData TypeDescription
order_id[integer]The unique identifier of the certificate order related to the request

Sample Request

Endpoint

https://api.digicert.com/order/wfa

Headers

Authorization: Basic MDAxMDA3OnNreWZhbGw=
Content-Length: 975
Content-Type: application/vnd.digicert.rest-v1+json
User-Agent: MyAPIConsumer/0.42

Body

{
  "server_type": "2",
  "validity": "2",
  "common_name": "www.example.com",
  "org_name": "Tampa Bay Cray LLC",
  "org_addr1": "1234 Sesame Street",
  "org_city": "Tampa",
  "org_state": "FL",
  "org_zip": "33615",
  "org_country": "US",
  "org_contact_firstname": "Joe",
  "org_contact_lastname": "Bloggs",
  "org_contact_email": "joe@example.com",
  "org_contact_telephone": "555-123-1234",
  "csr": "-----BEGIN CERTIFICATE REQUEST-----\n[CSR GOES HERE]\n-----END CERTIFICATE REQUEST-----",
  "default_logo_url": "http://www.example.com/wifi-logos/default.png",
  "additional_logos": [
    {
        "language": "spa",
        "url": "http://www.example.com/wifi-logos/spanish.png"
    },
    {
        "language": "deu",
        "url": "http://www.example.com/wifi-logos/german.png"
    }
  ],
  "friendly_names": [
    {
        "language": "spa",
        "text": "Wifi Publica"
    },
    {
        "language": "kor",
        "text": "공공 와이파이"
    }
  ]
}

Sample Response

Note that with this sample request, it would return JSON. Including XML for comparison.

Status Code: 201

Headers

Content-Length: 25
Content-Type: application/vnd.digicert.rest-v1+json

Body

JSON (application/vnd.digicert.rest-v1+json)XML (application/vnd.digicert.rest-v1+xml)
{
  "order_id":00222307
}
<response>
  <order_id>00222307</order_id>
</response>