API SSLmarketu pre objednávanie certifikátov
SSLmarket ponúka API, ktorá umožňuje jednoducho zadávať objednávky takmer všetkých certifikátov z našej ponuky. Pomôže urýchliť objednávanie väčšieho množstva certifikátov a vy sa môžete venovať tomu, čo je pre vaše podnikanie skutočne dôležité. Nižšie nájdete dokumentáciu, ktorá vám pomôže rozbehnúť objednávanie certifikátov cez API a ušetriť váš čas!
Pre ľahkú implementáciu využijete špecifikáciu OpenAPI a Swagger.
Ako API SSLmarketu využiť
API je možné využiť dvoma spôsobmi. Odporúčaným spôsobom je úplná implementácia do vášho systému či vlastného rozhrania na objednanie certifikátov. Tú ľahko vykonáte na základe tejto dokumentácie. Vďaka dodržaniu špecifikácie OpenAPI si u nás vygenerujete kompletnú špecifikáciu a jej integrácia je potom už veľmi jednoduchá.
Druhý spôsob využitia API je vhodný pre zákazníkov, ktorí nevedia programovať či nemajú k dispozícii programátora. Pomocou jednoduchého užívateľského rozhrania tretej strany Postman zadáte ľahko objednávku s využitím API, ale bez implementácia na strane zákazníka. V dôsledku toho si veľmi urýchlite prácu s certifikátmi a ich správu.
Objednávky budete schopní zadať ľahko a bez prehliadania celej objednávky, rovnako tak si vydané certifikáty môžete cez API stiahnuť. Odporúčame rozhranie Postmana skombinovať s našou vlastnou aplikáciou SSLmarket pre Windows.
Začiatky s API SSLmarketu
API SSLmarketu môžu začať používať všetci naši zákazníci. Nie je potrebné uzatvárať žiadne zmluvy a zdržiavať sa formalitami. Stačí, aby ste sa prihlásili do svojho účtu v zákazníckej administrácii av nastavení účtu 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 viazaný k danému zák. účtu).
Dokumentáciu potom odovzdajte vášmu programátorovi. Ten si ju ľahko načíta z endpointu openapi-specification, vo formáte OpenAPI špecifikácii. Parameter format môže mať hodnotu json alebo yaml. Odpoveď je vo formáte application/json alebo application/x-yaml.
GET https://www.sslmarket.sk/api/openapi-specification/format/json
V tomto formáte ju ľahko naimportujete do svojho prostredia či nástroja (napríklad Postman) a môžete API začať používať. API si môžete tiež vyskúšať tiež vo Swaggeri. Stačí navštíviť URL https://www.sslmarket.sk/api/swagger-ui/.
Autentizácia požiadaviek
Všetky otázky na API musia mať v hlavičke HTTP dotazu 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
Hosť: sslmarket.cz
X-Auth-Token: {{AUTH_TOKEN}}
Návratové hodnoty
Po úspešnom zavolaním endpointu vracia API stavový HTTP kód odpovede 2XX. Pri neúspešnom volaní vracia API stavový kód odpovede 4XX; v tele odpovede nájdete typ chyby (string) a jej popis.
Dostupné funkcie API SSLmarketu
Nižšie nájdete zoznam funkcií 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 potrebné pre volanie danej funkcie. Vstupné parametre sa rozlišujú na povinné, ktoré musíte v požiadavke odoslať, a nepovinné (voliteľné). V špecifikácii je pri každej funkcii uvedené jej použitie, adresa endpointu, popis vstupných a výstupných parametrov a formát odpovede.
- Vygenerovanie OpenAPI špecifikácie - s týmto krokom začnite, pozri odsek Začiatky s API SSLmarketu
- Zoznam produktov
- Preposlanie DCV e-mailu
- Vloženie novej objednávky
- Zoznam objednávok
- Detail objednávky
- Úprava objednávky
- Reissue certifikátu
- Zrušenie reissue certifikátu
- Revokácia certifikátu
- Stiahnutie certifikátu
- Dekodér CSR
- Dekodér certifikátu
- OCSP check
Je toho na vás veľa?
Radi vám s použitím API poradíme, alebo budeme počuť vašu spätnú väzbu. Neváhajte nám dať vedieť.
