Manuális munkálatok a Postman eszközzel az API-val

Ha nem szeretné integrálni az API-nkat a meglévő folyamatokba, vagy ha nincs hová integrálnia, akkor ez az útmutató segít API-kérelmek küldésében a Postman segítségével. Összességében elmondható, hogy programozási ismeretek nélkül használhatja vele az SSLmarket API-t és így időt takaríthat meg.

Az SSLmarket API integrálása más környezetekbe azzal az előnnyel jár, hogy a megoldásokat átfogóan tudja megvalósítanit. A kézikönyvben leírt megoldás nem működhet automatikusan, kizárólag csak manuálisan, de ezzel is időt spórolhat.

Postman applikáció telepítése

Letölti a webhelyről az Önnek megfelelő verziót. A Postman applikáció létezik webes verzióban is, az azonban számunkba nem megfelelő (nem működik).

A Windows-os verzió a hagyományos módon telpítendő, Linuxban valószínűleg a Postman snap csomagban áll rendelkezésére. A terminálba írja a következőket:

sudo snap install postman

Applikáció beállítása az SSLmarkethez

Az API és a programmal való munkálatok egyszerűsítéséért összeszedtünk Önöknek egy "kolekciót" a JSON fájlokban való parancsokra, amelyet elég importálni és az összes funkció máris rendelkezésükre áll. Importálja a kolekciót (balra lévő "import" gombbal), majd válassza a tőlünk kapott kész JSON fájlt. A Collentions-ben megtalálja ezután az SSLmarket fület tíz funkcióval. Kattintson az SSlmarket kolekcióra jobb gombbal és állítsa be a változókat: "Edit → Variables".

A legfontosabb beállítandó változó a X-Auth-Token érték az Ügyfélfiók számára. A további változók értékét logikával kikövetkeztetheti, alább természetesen láthatja azok áttekintését.

Mezők magyarázata

• X-Auth-Token – API kulcs beillesztésének helye
• owner_### - adatok a leendő tanúsítvány tulajdonságáról a pontosításért.
• auth_### - autorizációs személyes adatai, aki megerősíti a tanúsítvány megrendelését.
• tech_### - technikai személyes adatai, aki a hitelesítésben nem veszi részt, de megkapja a kiállított tanúsítványt e-mailen.
• invoice_### - számlázási adatok pontosításának helye; ezen információk határozzák meg a számlázásnál a vevőt.

Ezen alapértékeket fognak ajánlásra kerülni a változók között (pl a megrendelés megadásánál) és nem szükséges ezeket újra megadniuk. Amennyiben valamelyik mező nem egyértelmű, úgy ezek leírását megtalálja az API dokumentációban.

A beállítások befejezése és a feltüntetett összs információ után elkezdheti küldeni a kérelmeket az SSLmarket API-ba.

Kérelmek küldése

A program beállítása után elkezdheti küldözgetni a kérelmeket és új megrendeléseket. A CSR-nek szóközök és törések nélkülinek kell lennie, ezeket megoldhatja az escape sekvence segítségével, amelyekről a következő bekezdésben olvashat.

Válassza ki a kolekcióból az API funkciót, amelyet használni kíván. Ezután az ablak jobb (nagy) oldalán a Body fülnél megtalálja a mezők konstrukcióját. Például a megrendelés beillesztése során megtalálja ott az összes információt a leendő tanúsítványról (a tartalom megfel a webhelyen található megrendelésnek). A zárójelben látható információk a váltózókként megadott adatok jelentik, pl. {{owner_name}}. Ezen tételeket csak akkor javítsa amennyiben más adatok használatára van szüksége, mint az alapértelmezetként megadottak.

Adatok a megrendelés beillesztéséhez

A kérelmező és a kapcsolati adatok az alapértelmezett adatok szerint lesznek betöltve. Mindegyik megrendeléshez szükséges az alább látható specifikus adatokat meghatározni:

• domain - tanúsítvány Common name-je
• dns_names - SAN-ok listája a tanúsítványban
• years - évek száma a megrendelés érvényességének (a tanúsítvány érvényessége korlátozott, de a megrendelés több évre is szólhat)
• csr - ide illessze be a CSR-t (tördelés és szóközök nélkül, lsd. feljebb). Nem kötelező adat és a CSR-t beilleszhető az SSLmarket-en is, a megrendelés API-n keresztül történő beillesztése után.
• dv_auth_method - domain, DCV hitelesítés módjának változtatása (email, dns, ftp)

Amint az összes adat kitöltésre került és a kérelem elkészült, elküldheti azt az API-ba a kék Send gombra kattintva.

A kérelem állapotát és eredményétek az ablak alsó részében láthatja. Amennyiben az eredmény sikeres, úgy megkapja a kért információt vagy a megrendelés számát, ha leadta a megrendelést. Más esetben hibaüzenetet kap, amely megjelöli a hibás vagy hiányzó adatok a kérelemben.

Példa a sikeres megrendelés beillesztéshez:

{
    "order_id": "155252"
}

Példa a hibajelentéshez:

   {
    "error": [
        "dv_auth_method => isEmpty - Kötelező elem, nem maradhat üres"
    ]
}

Lehetséges hibák a megrendelések küldésénél

• Használt URL – használt endpoint URL használata www.sslmarket.tld, nem pedig sslmarket.tld. Az alap domain címről átirányítás majd hiba történik a kérelmekkel.
• CSR request - Figyeljen arra hogy a CSR ne legyen több sorra osztva. Amennyiben problémát okoz a CSR megfelelő alakban való behelyezése, úgy küldje el a megrendelést nélküle és a megszokott módon helyezze azt be az adminisztráción keresztül.
  • CSR-t nem lehet sorokra szétosztva elküldeni, mégha a serverről ilyen formában is kapja azt meg.
  • A CSR-ben nem szerepelhetnek szóközök, sorok vagy tördelések; a sorokat rn. "escape sequence"-kal fejezze be
  • CSR-t könnyen javíthatja a megfelelő alakra a ľahko upravíte do vhodného tvaru jedným kliknutím s použitím nástroja "Remove or replace line breaks" eszközre kattintva. Válassza a „Replace line breaks with customer text“ lehetőséget és szövegként adja meg az rn.-t. A további lehetőségeket szüntesse meg és kattintson a zöld gombra lejjebb.

FAQ az API manuális használatához