REST API rozhraní

Úvod > Spolupráce > REST API rozhraní

Z důvodu migrace zákaznických účtu Active 24 na naší novou platformu, Websupport.cz, již nedoporučujeme si nově nastavovat REST API rozhraní.
V případě otázek prosíme kontaktujte zákaznickou podporu Active 24.

 

RESTové API je rozhraní přes které můžete ovládat služby, které jste si u nás zakoupili, pomocí vlastních aplikací.

Každý požadavek zaslán přes API musí být autorizován pomocí HTTP headeru s hodnoutou Bearer TOKEN.

Správu tokenu naleznete v zákaznickém centru v editaci uživatelského účtu.
 

Jak aktivovat API REST rozhraní

Aktivování API není vázáno na žádná speciální práva účtu. Stačí si vytvořit a aktivovat tzv. token pod svým již existujícím zákaznickým účtem, případně si můžete vytvořit nový.

V zákaznickém centru v sekci Editace údajů zákaznického účtu přejdete do správy API. Zde můžete přidat nový token.

Tokenů můžete mít více, používají se pro autorizaci dotazů volané RESTem.

U svého účtu lze spravovat více tokenů, které můžete kdykoliv deaktivovat, viz Správa tokenů.
 

UPOZORNĚNÍ: Tokeny nelze spravovat ani vytvářet z tzv. účtu kontaktní osoby. Vždy je nutné použít "hlavní" firemní účet nebo účet vedený na fyzickou osobu.


Podrobný postup:

  1. Pomocí svých přihlašovacích údajů se přihlaste do Zákaznického centra. Případně si můžete požádat o zaslání zapomenutého hesla.
  2. V pravém horním rohu klikněte na jméno firmy / uživatele. Případně použijte odkaz do správy API a přejděte k bodu 4.
  3. Úplně dole rozklikněte šipku u API. Nyní můžete Přejít do správy API. 
  4. Klikněte na dlaždicové tlačítko Přidat nový token. 
  5. Samotná poznámka je dobrovolný údaj, který pomáhá udržovat přehled vytvořených tokenů.
  6. Datum expirace je také dobrovolný údaj. 
  7. Omezení přístupu určuje IP adresu zařízení, které může s tokenem pracovat. Kdyby zařízení s jinou IP adresou použilo funkční token, nebudou se vykonávat jeho požadavky - požadavek nebude autorizován.
  8. Jakmile vyplníte vše potřebné, můžete Přidat nový token. Přidání tokenu je nutné potvrdit zadáním hesla k účtu.
     

Správa tokenů

Veškeré vytvořené tokeny můžete spravovat v zákaznickém centru.

Dohledáte je v sekci Editace údajů zákaznického účtu ve správě API. Pro jejich zobrazení je nutné z bezpečnostních důvodů zadat heslo k účtu.

Po rozkliknutí Detailu naleznete možnosti pro úpravu poznámky k tokenu nebo nastavíte jeho omezení, ať už datum expirace nebo povolit přístup z konkrétní IP adresy.

Omezení IP adresou funguje pouze pro jednu IP adresu nebo masku v CIDR notaci. Pokud potřebujete omezit přístup z více adres, je nutné založit pro každou IP nový token.

Vytvořené tokeny lze kdykoliv deaktivovat. Tokenu poté může trvat až 10 minut než dojde k jeho deaktivaci. 

Deaktivované tokeny nejde úplně smazat, u účtu zůstanou zaevidované, aby uživatel mohl kdykoliv dohledat jaké tokeny v minulosti používal. 

 

Vývojářské prostředí - sandbox

Každý požadavek zaslán přes API musí být autorizován pomocí HTTP headeru s hodnoutou Bearer TOKEN.

Dřív, než si vytvoříte vlastní token, můžete při vývoji použít sandbox prostředí na serveru pouze přes zabezpečený port https://sandboxapi.active24.com. Platný token pro tento sandbox je 123456qwerty-ok.

Požadavky na tento sandbox nevyvolají žádnou změnu na systému ani službě, slouží pro odzkoušení napsaných dotazů.

Dokumentace k vývojářskému prostředí je dostupná na adrese https://sandboxapi.active24.com.

Produkční prostředí a dokumentace

Produkční prostředí REST API běží na serveru pouze přes zabezpečený port https://api.active24.com.

Specifikace všech metod dostupných v API naleznete v dokumentaci na adrese https://api.active24.com.

Aktualizováno:

Ostatní články