Zákaznícke API WebHouse

Cez zákaznícke API si údaje o svojich doménach, hostingoch a e-mailových schránkach načítate priamo do vlastných systémov – bez prihlasovania do Setupu.

Zákazníkom, ktorí spravujú viac služieb a chcú mať o nich prehľad vo vlastných nástrojoch: v internom monitoringu, v tabuľke, v účtovnom alebo helpdeskovom systéme. Nasadzuje ho spravidla váš vývojár alebo správca serverov.

Ak máte jednu doménu alebo jeden hosting, API pravdepodobne nepotrebujete – všetko podstatné nájdete priamo v Setupe.

API slúži výhradne na čítanie údajov. Nedá sa cez neho nič objednať, zmeniť ani zrušiť – na to naďalej slúži Setup.

Pri vytváraní tokenu si vyberáte, ku ktorým údajom bude mať prístup:

• account:read – základné údaje zákazníckeho účtu
• services:read – zoznam vašich služieb
• domains:read – domény, ich stav a dátumy expirácie
• domains:pricing – ceny predĺženia domén
• hosting:read – parametre hostingov a priradené domény
• usage:read – obsadenosť priestoru a kvóty
• mail-domains:read – súhrny mailových domén
• mailboxes:read – e-mailové schránky a ich obsadenosť

Token nikdy nezíska viac práv, než máte vy sami. Oprávnenie mailboxes:read sprístupňuje e-mailové adresy, preto ho prideľujte uvážlivo.

Token si vytvoríte v Setupe v menu Môj setup / API tokeny:

• kliknite na Vytvoriť token, pomenujte ho a vyberte oprávnenia a platnosť,
• vytvorenie potvrdíte heslom do Setupu a overovacím kódom, ak máte zapnuté dvojfaktorové overenie,
• token sa zobrazí jediný raz – ihneď si ho skopírujte a bezpečne uložte.

Token má tvar:

wh_live_xxxxxxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Token je viazaný na jedného používateľa a jedno zákaznícke konto. Ak máte prístup do viacerých kont, pre každé z nich potrebujete samostatný token. Tokeny môže vytvárať správca zákazníckeho účtu a používateľ s prístupom k službám.

• Token patrí len na server. Nikdy ho nevkladajte do verejného JavaScriptu, do mobilnej aplikácie ani do verejného repozitára.
• Uchovávame iba odtlačok tokenu. V čitateľnej podobe ho neukladáme, takže vám ho nevieme znovu zobraziť ani my. Pri strate vytvorte nový.
• Obmedzenie na IP adresy. K tokenu môžete pridať až 20 IP adries alebo rozsahov (IPv4 aj IPv6). Z iných adries nebude fungovať.
• Obmedzenie na vybrané služby. Token nemusí vidieť celý účet, len služby, ktoré mu určíte.
• Obmedzená platnosť. Predvolene 90 dní, najviac jeden rok.
• Rotácia bez výpadku. Token viete vymeniť za nový a pôvodnému nechať ešte 24 alebo 72 hodín na prechod.
• Okamžité zrušenie. Zrušený token prestane fungovať ihneď.

Ak máte podozrenie, že token unikol, zrušte ho v Setupe. Na jednom zákazníckom účte môže byť súčasne najviac 50 aktívnych tokenov.

Technický popis – zoznam koncových bodov, spôsob prihlásenia, formát odpovedí a príklady volaní – nájdete v dokumentácii zákazníckeho API.

Zákaznícke API je zatiaľ vo fáze BETA. Rozhranie sa môže ešte meniť a jeho dostupnosť negarantujeme, preto ho zatiaľ nenasadzujte na kritické systémy. Za spätnú väzbu budeme vďační.