REST API for developers

REST API is the interface through which you can control all the services you have purchased with us.

Every API request must be authorized using the HTTP header with value of Beer TOKEN.

Token management is placed to your user account details
 

How to activate the API REST token

There is no need to request special account rights to activate the API. Just create and activate a so-called token under your existing customer account, or you can create a new one.

You can add a new token at the Customer Center in the Customer data edit section. You may find Enter to API management in the bottom of the page.

It is possible to create more tokens, which will be used to authorize REST requests.
 

WARNING: Tokens can not be managed or created in a contact person account. It is always necessary to use a main company user account or a personal user account.

 

Detailed walkthrough:

  1. Using your login information log in to Customer center. Or you can ask for a new password.
  2. Click on the user name  in the upper right corner or you may use direct link to the API management.
  3. You may Enter to the API management at the bottom of this page.
  4. Use the Create a new token tile button to setup new API token. 
  5. The Comment is not mandatory, it simply helps to manage created tokens.
  6. The expiration date is also optional.
  7. In the Access restrictions can be specified the IP address of the device that can work with the token. If the device with a different IP address used functional token, it will not perform any requests - the requests cannot be authorized.
  8. Once you fill everything you need, you can Create a new token. There is a password confirmation required.

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.