This introduction contains a brief description to help you start interacting with API PBX.
We currently recognize 2 types of APIs:
IPBX API - centralized API containing a wide range of management/configuration options
Local API (deprecated) - API running on each PBX, will be part of IPBX API in the future
Prerequisites
Shell with curl and jq installed
Create user account - Komunikátor - modul administrace uživatelů s licencí Volání, Komplet, Callcentrum
Authentication
Authentication is based on providing Bearer {access_token} into Authorization header with every request. To obtain an access_token, make POST request to https://restapi.ipex.cz/v1/sso/login with credentials contained in the body.
Example of fetching the access_token:
curl -X POST -H "Content-Type: application/json" -d '{"email": "email@ipex.cz", "password": "password123"}' https://restapi.ipex.cz/v1/sso/login | jq ".access_token"
The token is valid for 1 hour. After expiration, the token must be restored with refresh_token obtained also in response from /v1/sso/login. More information is avalable on documentation page for REST API.
Example of refreshing token:
curl -X POST -H "Content-Type: application/json" -H "Authorization: f2e067729edd170d9c60" https://restapi.ipex.cz/v1/sso/refresh
Calling the API
The best way to try our API is to visit the documentation page. Before making requests, copy your token to the input field in topbar (do not forget to add Bearer before the token).
