WAPI – základní informace

WAPI – WEDOS API

API (Application Programming Interface – rozhraní pro programování aplikací) je rozhraní, určené pro komunikaci mezi aplikacemi. Jedná se vlastně o obdobu uživatelského rozhraní s tím rozdílem, že místo lidí jej využívají jiné programy a komunikace se tak může omezit pouze na předávání potřebných informací v co nejjednodušším formátu. 

WAPI tedy slouží k ovládání našich služeb přímo z vašeho informačního systému. Veškeré platby se odečítají ze zálohového účtu, není tak potřeba na nic čekat.

Podmínkou pro použití tohoto rozhraní je využívání zálohového účtu, ze kterého jsou odečítány platby za registrace, prodloužení, přeregistrace a další účtované poplatky.

Použití rozhraní

WAPI rozhraní v současné době umožňuje:

  • informace o stavu kreditu na zálohovém účtu
  • domény – dostupnost, registrace, prodloužení, změna DNS, seznam
  • poll fronta

Další příkazy a podporu dalších koncovek domén připravujeme.

Aktivace a nastavení

Abyste mohli používat WAPI rozhraní, musíte jej nejprve aktivovat. Aktivace a nastavení se provádí v zákaznickém centrum v záložce zákazník pod položkou menu WAPI.

Všechny příkazy musí být autorizovány pomocí Vašeho uživatelského jména (to samé, jakým se přihlašujete do zákaznického centra) a tzv. „WAPI heslem“ (toto heslo se liší od hesla pro přihlašování zákazníka).

Dále je nutné nastavit, z jakých IP adres se budete do WAPI rozhraní připojovat. Lze uvést seznam IP adres oddělených mezerou, případně lze také zadat prefix IP adresy (např.: ‚10.11.12.‘ – takto budou akceptovány dotazy z IP adres 10.11.12.1 – 10.11.12.255). POZOR! Rozhranní komunikuje také pomocí IPv6. Pokud tedy dotazy odesíláte z místa s IPv6 konektivitou (například z našeho webhostingu, nebo VPS), upřednostní se. V takovém případě je nutné přidat i tuto IPv6 adresu.

UPOZORNĚNÍ! Bez nastavení hesla a povolených IP adres vám WAPI rozhraní fungovat nebude!

Synchronní a asynchronní příkazy

Většina příkazů, prováděných přes rozhraní, je synchronní – tj. pošlete příkaz a ihned (během několika sekund) se dozvíte výsledek.

Některé operace jsou (resp. budou) asychronní. To znamená, že vyřízení takového příkazu může trvat velmi dlouho (i hodiny nebo dny) a rozhraní vám tedy nevrátí konečný výsledek, ale pouze informaci o tom, že byl příkaz přijat. Informace o průběhu a finální výsledek je vám pak doručován formou notifikací. Příkladem je přeregistrace EU domény, kde se musí čekat na potvrzení majitelem domény.

Zpětná vazba je dočasně nedostupná, máte-li k návodu dotaz nebo připomínku, napište nám přes kontaktní formulář.