REST API rozhranie

RESTové API je rozhranie cez ktoré môžete ovládať služby, ktoré ste si u nás zakúpili, pomocou vlastných aplikácií.

Každá požiadavka zaslaná cez API musí byť autorizovaná pomocou HTTP headera s hodnotou Bearer TOKEN.

Správu tokenu nájdete v Zákazníckom centre v editácii užívateľského účtu.

 

 

Ako aktivovať API REST rozhranie

Aktivovanie API nie je viazané na žiadne špeciálne práva účtu. Stačí si vytvoriť a aktivovať tzv. token pod svojim už existujúcim zákazníckym účtom, prípadne si môžete vytvoriť nový token.

V zákazníckom centre v sekcii Editácia údajov zákazníckeho účtu prejdite do správy API. Tu môžete pridať nový token.

Tokenov môžete mať viac, používajú sa pre autorizáciu požiadaviek volaných RESTom.

Pri svojom účte môžete spravovať viac tokenov, ktoré môžete kedykoľvek deaktivovať, viď Správa tokenov.

UPOZORNENIE: Tokeny sa nedajú spravovať ani vytvárať z tzv. účtu kontaktnej osoby. Vždy je potrebné použiť "hlavný" firemný účet alebo účet vedený na fyzickú osobu.

 

Podrobný postup:

  1. Pomocou svojich prihlasovacích údajov sa prihláste do Zákazníckeho centra. V prípade potreby si požiadajte o zaslanie zabudnutého hesla.
  2. V pravom hornom rohu kliknite na  meno firmy / užívateľa. Prípadne použite odkaz do správy API a prejdite k bodu 4.
  3. Celkom dole rozkliknite šípku pri API. Teraz môžete Prejsť do správy API.
  4. Kliknite na dlaždicové tlačidlo Pridať nový token.
  5. Samotná poznámka je dobrovoľný údaj, ktorý pomáha udržiavať prehľad vytvorených tokenov.
  6. Dátum exspirácie je dobrovoľný údaj.
  7. Obmedzenie prístupu určuje IP adresu zariadení, ktoré môžu s tokenom pracovať. Keby zariadenie s inou IP adresou použilo funkčný token, nebudú sa vykonávať jeho požiadavky - požiadavka nebude autorizovaná.
  8. Keď vyplníte všetko potrebné, môžete Pridať nový token. Pridanie tokenu je nutné potvrdiť zadaním hesla k účtu.

Správa tokenov

Všetky vytvorené tokeny môžete spravovať v Zákazníckom centre.

Vyhľadáte ich v sekcii Editácia údajov zákazníckeho účtu v správe API. Pre ich zobrazenie je nutné z bezpečnostných dôvodov zadať heslo k účtu.

Po rozkliknutí Detailu nájdete možnosti pre úpravu poznámky k tokenu alebo nastavíte jeho obmedzenie - dátum exspirácie a povolenie prístupu z konkrétnej IP adresy.

Obmedzenie IP adresou funguje len pre jednu IP adresu alebo masku v CIDR notácii. Ak potrebujete obmedziť prístup z viacerých adries, je nutné založiť pre každú IP nový token.

Vytvorené tokeny sa dajú kedykoľvek deaktivovať. Tokenu potom môže trvať až 10 minút než dôjde k jeho deaktivácii.

Deaktivované tokeny sa nedajú úplne zmazať, pri účte zostanú zaevidované, aby používateľ mohol kedykoľvek dohľadať aké tokeny v minulosti používal.


Vývojárske prostredie - sandbox

Každá požiadavka zaslaná cez API musí byť autorizovaná pomocou HTTP headera s hodnoutou Bearer TOKEN.

Skôr ako vytvoríte vlastný token, môžete pri vývoji použiť sandbox prostredie na serveri len cez zabezpečený port https://sandboxapi.active24.com. Platný token pre tento sandbox je 123456qwerty-ok.

Požiadavky na tento sandbox nevyvolajú žiadnu zmenu v systéme ani službe, slúžia pre odskúšanie napísaných požiadaviek.

Dokumentácia k vývojárskemu prostrediu je dostupná na adrese https://sandboxapi.active24.com.


Produkčné prostredie a dokumentácia

Produkčné prostredie REST API beží na serveri len cez zabezpečený port https://api.active24.com.

Špecifikáciu všetkých metód dostupných v API nájdete v dokumentácii na adrese https://api.active24.com.