API SSLmarketu pro objednávání certifikátů
SSLmarket nabízí API, která umožňuje snadno zadávat objednávky téměř všech certifikátů z naší nabídky. Pomůže urychlit objednávání většího množství certifikátů a vy se můžete věnovat tomu, co je pro vaše podnikání opravdu důležité. Níže najdete dokumentaci, která vám pomůže rozjet objednávání certifikátů přes API a ušetřit váš čas!
Pro snadnou implementaci využijte specifikaci OpenAPI a Swagger.
Jak API SSLmarketu využít
API je možné využít dvěma způsoby. Doporučeným způsobem je úplná implementace do vašeho systému či vlastního rozhraní pro objednání certifikátů. Tu snadno provedete na základě této dokumentace. Díky dodržení specifikace OpenAPI si u nás vygenerujete kompletní specifikaci a její integrace je pak už velice snadná.
Druhý způsob využití API je vhodný pro zákazníky, kteří neumí programovat či nemají k dispozici programátora. Pomocí jednoduchého uživatelského rozhraní třetí strany Postman zadáte snadno objednávku s využitím API, ale bez implementace na straně zákazníka. V důsledku si také velmi urychlíte práci s certifikáty a jejich správu.
Objednávky budete schopni zadat snadno a bez procházení celé objednávky, stejně tak si vydané certifikáty můžete přes API stáhnout. Doporučujeme zkombinovat rozhraní Postman s naší vlastní aplikací SSLmarket pro Windows.
Začátky s API SSLmarketu
API SSLmarketu mohou začít používat všichni naši zákazníci. Není potřeba uzavírat žádné smlouvy a zdržovat se formalitami. Stačí, abyste se přihlásili do svého účtu v zákaznické administraci a v nastavení účtu aktivovali "Přístup k účtu přes API". Tím vám bude vygenerován individuální API klíč pro přístup k API SSLmarketu (klíč je vázán k danému zák. účtu).
Dokumentaci pak předejte vašemu programátorovi. Ten si ji snadno načte z endpointu openapi-specification, ve formátu OpenAPI specifikace. Parametr format může mít hodnotu json či yaml. Odpověď je ve formátu application/json nebo application/x-yaml.
GET https://www.sslmarket.cz/api/openapi-specification/format/json
V tomto formátu ji snadno naimportujete do svého prostředí či nástroje (například Postman) a můžete API začít používat. API si můžete rovněž vyzkoušet též ve Swaggeru. Stačí navštívit URL https://www.sslmarket.cz/api/swagger-ui/.
Autentizace požadavků
Všechny dotazy na API musí mít v hlavičce HTTP dotazu uvedený přístupový autentizační token (X-Auth-Token). Ten naleznete v nastavení účtu poté, co aktivujete 'Přístup k účtu přes API'.
GET /api/order/list HTTP/1.1
Host: sslmarket.cz
X-Auth-Token: {{AUTH_TOKEN}}
Návratové hodnoty
Po úspěšném zavoláním endpointu vrací API stavový HTTP kód odpovědi 2XX. Při neúspěšném volání vrací API stavový kód odpovědi 4XX; v těle odpovědi najdete typ chyby (string) a její popis.
Dostupné funkce API SSLmarketu
Níže naleznete seznam funkcí API, které využijete pro objednání a stažení všech digitálních certifikátů z naší nabídky.
Každá funkce je přístupná přes vlastní endpoint, na který odesíláte požadavek obsahující parametry potřebné pro volání dané funkce. Vstupní parametry se rozlišují na povinné, které musíte v požadavku odeslat, a nepovinné (volitelné). Ve specifikaci je u každé funkce uvedeno její použití, adresa endpointu, popis vstupních a výstupních parametrů a formát odpovědi.
- Vygenerování OpenAPI specifikace - s tímto krokem začněte, viz odstavec Začátky s API SSLmarketu
- Seznam produktů
- Přeposlání DCV e-mailu
- Vložení nové objednávky
- Seznam objednávek
- Detail objednávky
- Úprava objednávky
- Reissue certifikátu
- Zrušení reissue certifikátu
- Revokace certifikátu
- Stažení certifikátu
- Dekodér CSR
- Dekodér certifikátu
- OCSP check
Je toho na vás moc?
Rádi vám s použitím API poradíme, nebo uslyšíme vaši zpětnou vazbu. Neváhejte nám dát vědět.
+420 511 150 150
+420 730 162 600
