API SSLmarketu pre objednávanie certifikátov

SSLmarket podporuje API pre objendanie TLS certifikátov. API umožňuje ľahko zadávať objednávky takmer všetkých certifikátov z našej ponuky . Po vystavení si ich môžete tiež ľahko stiahnuť. Nižšie nájdete dokumentáciu, ktorá vám pomôže rozbehnúť objednávanie certifikátov cez API a ušetrí váš čas!

API vám pomôže hlavne pokiaš objednávate väčšie množst o certifikátov. Pomôže urýchliť objednávanie a vy sa môžete venovať tomu, čo je pre vaše podnikanie naozaj dôležité.

Dôležité funkcie API SSLmarketu

Cez API SSLmarketu (Application Programming Interface) môžete objednávať takmer všetky typy certifikátov, ktoré máme v ponuke (výnimkou sú iba produkty, ktoré nie je možné automatizovať). Stačí odoslať všetky informácie v rovnakom rozsahu, ktorý požaduje objednávkový formulár na SSLmarkete a objednávka sa vo vašom účte založí. PI podporuje všetky parametre certifikátov vrátane SANov (ďalších domén v certifikáte) .

  • Objednávanie všetkých typov certifikátov (okrem niekoľkých výnimiek)
  • Ľahke stiahnutie certifikátu po vydaní
  • Definícia všetkých parametrov objednávky
  • Objednanie jedným kliknutím (pomocou nástroja)
  • Urýchlenie procesov a úspora vášho času
  • Možnosč nastaviť defaultné údaje pre vašu firmu

Ako API SSLmarketu využiť

API je možné využiť dvomi spôsobmi. Odporúčaným spôsobom je implementácia do vášho systému či vlastného rozhrania pre objednávanie certifikátov. K tomu stačí požnať informácie uvedené nižšie. Druhý spôsob je vhnodný pre zákazníkov, ktorí nevedia programovať či nemajú k dispozícii programátora. Pomocou jednoduchého užívateľského rozhrania, ktoré momentálne pripravujeme, zadáte ľahko objednávku s využitím API, ale bez implementácie na strane zákazníka. V konečnom dôsledku si tak veľmi urýchlite prácu s certifikátmi a ich správu.

Začiatky s API SSLmarketu

API SSLmarketu môžu začať používať všetci naši zákazníci. Nie je potreba uzatvárať žiadne zmluvy a zdržovať sa formalitami. Stačí abyste sa prihlásili do svojho účtu v zákazníckej administrácii a v nastavení aktivovali "Prístup k účtu cez API". Tým vám bude vygenerovaný individuálny API kľúč pre prístup k API SSLmarketu (kľúč je viazsný k danému zák. účtu). Dokumentáciu potom predajte vášmu programátorovi.

Pre volanie API využite následujúcu URL: https://www.sslmarket.sk/api

Autentizácia požiadaviek

Všetky otázky na API musia mať v hlavičke HTTP volaní uvedený prístupový autentizačný token (X-Auth-Token). Ten nájdete v nastavení účtu potom, čo aktivujete 'Prístup k účtu cez API'.

GET /api/order/list HTTP/1.1
Host: sslmarket.cz
X-Auth-Token: {{AUTH_TOKEN}}

Návratové hodnoty

Po úspešnom zavolaní endpointu vracia API stavový HTTP kód odpovede 2XX. Pri neúspěšnom volání vracia API stavový kód odpovede 4XX; v tele odpovedí nájdete typ chyby (string) a jej popis.

Dostupné funkcie API SSLmarketu

Nižšie nájdete zoznam funkčnej API, ktorú využijete pre objednanie a stiahnutie všetkých digitálnych certifikátov z našej ponuky.

Každá funkcia je prístupná cez vlastný endpoint, na ktorý odosielate požiadavku obsahujúcu parametre pre volanie do danej funkcie. Vstupné parametre sa rozlišujú na povinné, ktoré musíte v požiadavke odoslať a nepovinné (voliteľné). Pri každej funkcii je ivedené jej použitie, adresa endpointu, popis vstupních a výstupních parametrov a formát odpovedí.

Funkcia vracia zoznam produktov, ktoré sú dostupné v API.

GET /product/list
  • Stavový kód HTTP odpovedí: 200
  • Datový formát odpovedí: application/json

Výstupné parametre

Meno Typ Popis
products array
.. product_type string Typ produktu. Parameter má hodnotu ssl_certificate alebo client_certificate
.. product_code string Kód produktu
.. title string název produktu
.. type string certifikačná autorita
.. validate_type string Typ overenia certifikátu. Parameter má hodnotu dv, ov alebo ev
.. csr_required string Povinné CSR. Parameter má hodnotu true alebo false
.. max_years string Maximální doba platnosti certifikátu
.. min_san_values int Minimálny počet SANov
.. max_san_values int Maximálny počet SANov

  
{
    "products": [
        {
            "product_type": "ssl_certificate",
            "product_code": "digicert-standard-ssl",
            "type": "DigiCert",
            "title": "Standard SSL",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "digicert-wildcard",
            "type": "DigiCert",
            "title": "WildCard",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "digicert-ev-ssl",
            "type": "DigiCert",
            "title": "EV SSL",
            "validate_type": "ev",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "geotrust-geotrust-standard-dv-ssl",
            "type": "GeoTrust",
            "title": "DV SSL",
            "validate_type": "dv",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "geotrust-geotrust-wildcard-dv",
            "type": "GeoTrust",
            "title": "DV SSL Wildcard",
            "validate_type": "dv",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "rapidssl-rapidssl-dv",
            "type": "RapidSSL",
            "title": "RapidSSL DV",
            "validate_type": "dv",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-client-premium-class-1",
            "type": "DigiCert",
            "title": "Client Premium Class 1",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-ssl",
            "type": "DigiCert",
            "title": "Secure Site SSL",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "thawte-ssl-123-dv",
            "type": "Thawte",
            "title": "SSL 123 DV",
            "validate_type": "dv",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-client-premium-class-2",
            "type": "DigiCert",
            "title": "Client Premium Class 2",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "rapidssl-rapidssl-wildcard-dv",
            "type": "RapidSSL",
            "title": "RapidSSL Wildcard DV",
            "validate_type": "dv",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "geotrust-truebusiness-id-ov",
            "type": "GeoTrust",
            "title": "TrueBusiness ID OV",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "thawte-ssl-webserver-ov",
            "type": "Thawte",
            "title": "SSL Webserver OV",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-pro-ssl",
            "type": "DigiCert",
            "title": "Secure Site Pro SSL",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "thawte-ssl-webserver-ov-wildcard",
            "type": "Thawte",
            "title": "SSL Webserver OV Wildcard",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "geotrust-truebusiness-id-ov-wildcard",
            "type": "GeoTrust",
            "title": "TrueBusiness ID OV Wildcard",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-document-signing-individual-500",
            "type": "DigiCert",
            "title": "Document Signing - Individual (500)",
            "validate_type": "ev",
            "csr_required": "false",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-ev-ssl",
            "type": "DigiCert",
            "title": "Secure Site EV SSL",
            "validate_type": "ev",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "geotrust-truebusiness-id-ev",
            "type": "GeoTrust",
            "title": "TrueBusiness ID EV",
            "validate_type": "ev",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "thawte-ssl-webserver-ev",
            "type": "Thawte",
            "title": "SSL Webserver EV",
            "validate_type": "ev",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-document-signing-individual-2000",
            "type": "DigiCert",
            "title": "Document Signing - Individual (2000)",
            "validate_type": "ev",
            "csr_required": "false",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-pro-ev-ssl",
            "type": "DigiCert",
            "title": "Secure Site Pro EV SSL",
            "validate_type": "ev",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-document-signing-organization-2000",
            "type": "DigiCert",
            "title": "Document Signing Organization (2000)",
            "validate_type": "ev",
            "csr_required": "false",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "client_certificate",
            "product_code": "quovadis-rsassa-pss-smime",
            "type": "QuoVadis",
            "title": "RSASSA-PSS S/MIME",
            "validate_type": "qv",
            "csr_required": "false",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-wildcard-ssl",
            "type": "DigiCert",
            "title": "Secure Site Wildcard SSL",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        },
        {
            "product_type": "client_certificate",
            "product_code": "digicert-document-signing-organization-5000",
            "type": "DigiCert",
            "title": "Document Signing Organization (5000)",
            "validate_type": "ev",
            "csr_required": "false",
            "max_years": "3",
            "min_san_values": "0",
            "max_san_values": "0"
        },
        {
            "product_type": "ssl_certificate",
            "product_code": "symantec-secure-site-pro-ssl-wildcard",
            "type": "Digicert",
            "title": "Secure Site Pro Wildcard",
            "validate_type": "ov",
            "csr_required": "true",
            "max_years": "6",
            "min_san_values": "0",
            "max_san_values": "250"
        }
    ]
}
 

Funkcia slúži k vloženiu objednávky na daný zákaznícky účet.

POST /order/certificate/{{PRODUCT_CODE}}
  • {{PRODUCT_CODE}} - kód produktu
  • Stavový kód HTTP odpovedí: 201
  • Datový formát požiadavky: application/json
  • Datový formát odpovedí: application/json

Vstupné parametre

Meno Typ Povinné Popis
domain string ano názov domény, pre ktorú má byť certifikát vystavený
dns_names array ne Pole domén vložených v SAN
years int ano Platnosč certifikátu
csr string ano* CSR request pre certifikát
voucher string ne Zľavový kupón
dv_auth_method string ne Spôsob overenia vlastníka domény. Prístupové hodnoty sú Email, FILE alebo DNS. Východzia hodnota je Email
owner_name string ano meno vlastníka certifikátu
owner_street string ano ulica vlastníka certifikátu
owner_city string ano mesto vlastníka certifikátu
owner_zip string ano PSČ vlastníka certifikátu
owner_country string ano dvojpísmenový kód zeme vlastníka certifikátu (ISO 3166-1 alpha-2)
owner_tel string ano telef=on vlastníka certifikátu v tvare +421.00000000
auth_title string ano
auth_firstname string ano meno vlastníka certifikátu
auth_lastname string ano priezvisko vlastníka certifikátu
auth_tel string ano telefón vlastníka certifikátu v tvaru tvare +421.00000000
auth_email string ano e-mail vlastníka certifikátu
tech_title string ano
tech_firstname string ano meno technickej osoby certifikátu
tech_lastname string ano priezvisko technickej osoby certifikátu
tech_email string ano e-mail technickej osoby certifikátu
tech_tel string ano telefón technickej osoby certifikátu v tvaru tvare +421.00000000
invoice_name string ano fakturačné meno subjektu certifikátu
invoice_street string ano fakturačná ulice subjektu certifikátu
invoice_city string ano fakturačné město subjektu certifikátu
invoice_zip string ano fakturačné PSC subjektu certifikátu
invoice_country string ano fakturačný dvojpísmenový kód krajiny subjektu certifikátu (ISO 3166-1 alpha-2)
invoice_email string ano fakturačný email certifikátu
invoice_ic string ne fakturačné IČO subjektu certifikátu
invoice_dic string ne fakturačné DIČ subjektu certifikátu

* Záleží na type certifikátu

Výstupné parametre

Číslo objednávky je interné označenie používané v administrácii SSLmarketu; môžete ho použiť vo vyhľadávaní.

Meno Typ Popis
order_id int Číslo objednávky

Funkcia vypíše zoznam objednávok v danom zákaznickom účte.

GET /order/list
  • Stavový kód HTTP odpovedí: 200
  • Datový formát odpovedí: application/json

Výstupné parametre

Meno Typ Popis
orders array Pole objednávok
.. order_id int Číslo objednávky
.. product_type string Typ produktu
.. product_code string Kód produktu
.. domain string názov domény, pre ktorú má byť certifikát vystavený
.. dns_names array Pole domén vložených v SAN
.. sans_order_count int Počet SANov vložených v objednávke
.. years int Platnosť certifikátu
.. inserted datetime Dátum a čas vloženia objednávky
.. published datetime Dátum a čas vystavenia certifikátu
.. expired date Dátum konca platnosti certifikátu

Funkcia vypíše detail konkrétnej objednávky certifikátu, ktorú môžete nájsť aj v zákazníckej administrácii.

GET /order/order_id/{{ORDER_ID}}
  • {{ORDER_ID}} - číslo objednávky
  • Stavový kód HTTP odpovedí: 200
  • Datový formát odpovedí: application/json

Výstupné parametre

Meno Typ Popis
product_type string Typ produktu
product_code string Kód produktu
domain string názov domény, pre ktorú má být certifikát vystavený
dns_names array Pole domén vložených v SAN
sans_order_count int Počet SANov vložených v objednávke
years int Platnosť certifikátu
csr string CSR request pre certifikát
owner_name string meno vlastníka certifikátu
owner_street string ulica vlastníka certifikátu
owner_city string mesto vlastníka certifikátu
owner_zip string PSČ vlastníka certifikátu
owner_country string dvojpísmenový kód krajiny vlastníka certifikátu (ISO 3166-1 alpha-2)
owner_tel string telefón vlastníka certifikátu v tvare +421.00000000
auth_title string
auth_firstname string meno autorizačnej osoby certifikátu
auth_lastname string priezvisko autorizačnej osoby certifikátu
auth_tel string telefón autorizačnej osoby certifikátu v tvare +421.000000004
auth_email string e-mail autorizačnej osoby certifikátu
tech_title string
tech_firstname string meno technickej osoby certifikátu
tech_lastname string priezvisko technickej osoby certifikátu
tech_email string e-mail technickej osoby certifikátu
tech_tel string telefón technickej osoby certifikátu v tvare +421.00000000
inserted datetime Dátum a čas vloženia objednávky
published datetime Dátum a čas vystavenia certifikátu
expired date Dátum konca platnosti certifikátu
dv_auth_method string Spôsob overenia vlastníka domény. Parameter je v odpovedi obsiahnutý len pokiaľ product_type=ssl_certificate
dv_auth_content string Unikátna hodnota pre overenie vlastníka domény. Parameter je v odpovedi obsiahnutý iba pokiaľ product_type=ssl_certificate a dv_auth_method=DNS nebo dv_auth_method=FILE

Funkcia slúži k pregenerovaniu certifikátu jeho znovuvidaniu. Používá sa typicky pri strate privátneho kľúča a je zadarmo. Certifikát vydaný po reissue má rovnaké parametre a dátum expirácie ako pôvodný.

POST /certificate/order_id/{{ORDER_ID}}/reissue
  • {{ORDER_ID}} - číslo objednávky
  • Datový formát požiadavky: application/json
  • Stavový kód HTTP odpovede: 202

Vstupné parametre

Meno Povinné Typ Popis
csr ano string CSR request pre certifikát

Fukcia revokácie certifikátu nevratne zneplatní daný certifikát a nebudete ho môcť ďalej využiť. Revokácia znamená znehodnotenie certifikátu bez náhrady a slúži pre prípady zneužitia (kompromitácie) privátneho kľúča certifikátu.

PUT /certificate/order_id/{{ORDER_ID}}/revoke
  • Dostupné len pre produkty DigiCert Client Premium Class 1 a Client Premium Class 2
  • {{ORDER_ID}} - číslo objednávky
  • Stavový kód HTTP odpovedí: 202

Funkcia slúži k stiahnutiu vydaného certifikátu vo vybranom formáte, ktorý upresníte vo vstupnom parametry{{FORMAT}}. PEM je textový formát certifikátu v Base64, naopak P7B je formát binárny.

GET /certificate/order_id/{{ORDER_ID}}/format/{{FORMAT}}
  • {{ORDER_ID}} - číslo objednávky
  • {{FORMAT}} - formát certifikátu
    • pem_server - vrátí koncový (serverový, leaf) certifikát v textovom formáte Base64.
    • pem_intermediate - vrátí spolu s koncovým certifikátem aj intermediate certifikát, ktorý je jeho vydávateľom. Je potreba pre inštaláciu certifikátu. Tento formát je vhodný pre Apache, nginx a obecne pre linuxové servery.
    • p7b - vráti koncový (serverový) certifikát spolu s jeho chainom (intermediate + korenový certtifikát) v binárnom formáte P7B (PKCS#7).
  • Stavový kód HTTP odpovedí: 200
  • Datový formát odpovedí: text/plain
záchranný kruh sslmarket

Je toho na vás veľa?

Radi vám s použitím API poradíme, alebo si vypočujeme vašu spätnú väzbu. Neváhajte nám dať vedieť.

Napište nám
info@sslmarket.sk
Kontaktný formulár
Zavolejte nám
+421-2-682 65 986