Model Classes

This section contain the model classes for the RCL SSL Core API.

Certificate

Represents a SSL/TLS certificate

Parameter	Description	Type
id	The id of the certificate.	int
certificateName	The name of the certificate.	string
rootDomain	The root domain for the certificate.	string
email	The email contact for the user creating the certificate.	string
challengeType	The challenge type to validate the certificate (‘HTTP’ or ‘DNS’).	string
orderUri	The Lets Encrypt URI for the certificate order.	string
issueDate	The issue date of the certificate.	DateTime
expiryDate	The expiry date of the certificate.	DateTime
password	The password for the certificate.	string
pfxString	The string format of the PFX certificate.	string
certificateDownloadUrl	The download urls for various certificate formats.	CertificateDownloadUrl

Example

{
    "certificateName": "shopeneur.com",
    "rootDomain": "shopeneur.com",
    "email": "support@mail.com",
    "challengeType": "DNS",
    "orderUri": "https://acme-v02.api.letsencrypt.org/acme/order/116443104/10561456874",
    "issueDate": "2023-08-28T16:54:45.7728501",
    "expiryDate": "2023-11-26T16:54:45.7729979",
    "id": 341,
    "password": "pwd1234",
    "pfxString": "MIACAQ..SwQUa6VcuNGqfAd9OKA7LC2PjJGFH+oCAgQAAAA=",
    "certificateDownloadUrl": {
        "pemUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.pem",
        "pfxUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.pfx",
        "cerUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.cer",
        "crtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.crt",
        "txtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-certdownload.txt",
        "keyUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.key",
        "keyTxtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.txt",
        "certCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-cert.crt",
        "cabundleCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-cabundle.crt",
        "fullchainCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-fullchain.crt"
    }
}

CertificateDownloadUrl

Represents the download URLs for various certificate formats

Parameter	Description	Type
pemUrl	The download url for the .PEM format.	string
pfxUrl	The download url for the .PFX format.	string
cerUrl	The download url for the .CER format.	string
crtUrl	The download url for the .CRT format.	string
txtUrl	The download url for the .TXT format.	string
keyUrl	The download url for the private key in .KEY format.	string
certCrtUrl	The download url for the Certificate in .CRT format.	string
cabundleCrtUrl	The download url for the Certificate Bundle in .CRT format.	string
fullchainCrtUrl	The download url for the Full Chain Certificate in .CRT format.	string

Example

{
    "pemUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.pem",
    "pfxUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.pfx",
    "cerUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.cer",
    "crtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.crt",
    "txtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-certdownload.txt",
    "keyUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.key",
    "keyTxtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4.txt",
    "certCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-cert.crt",
    "cabundleCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-cabundle.crt",
    "fullchainCrtUrl": "https://path/153c904c-0832-4381-bbf9-20f2324ce8f4-fullchain.crt"
}

Order

Represents a SSL/TLS certificate order

Parameter	Description	Type
status	The status of the order (pending, ready or invalid).	string
validationTokens	An array of ValidationToken required to validate the order (prove ownership of the domain).	string
orderUri	The URI or the order in Let’s Encrypt.	string
certificateUri	The URI to download the certificate from Let’s Encrypt.	string

Example

{
    "status": "pending",
    "validationTokens": [
        {
            "tokenName": "_acme-challenge",
            "tokenValue": "pder_53er44PhE-keudgge45630",
            "challengeType": "DNS",
            "domain": "shopeneur.com"
        }
    ],
    "orderUri": "https://acme-v02.api.letsencrypt.org/acme/order/116443104/10567267084",
    "certificateUri": null
}

ValidationToken

Represents a token to validate (prove ownership of a domain) a certificate order

Parameter	Description	Type
tokenName	The name of the token. For a DNS Challenge, it will be the TXT record to place in the the DNS provider. For the HTTP Challenge, it is the folder name to place at the root of the website	string
tokenValue	The value of the token. For a DNS Challenge, it will be the value of the TXT record to place in the the DNS provider. For the HTTP Challenge, it is the value to place at the root folder of the website	string
challengeType	The Challenge Type for the validation (DNS or HTTP)	string
domain	The domain (certificate name or Hostname) for which the certificate is sought	string

Example

{
    "tokenName": "_acme-challenge",
    "tokenValue": "pder_53er44PhE-keudgge45630",
    "challengeType": "DNS",
    "domain": "shopeneur.com"
}