Porovnat verze

Klíč

  • Tento řádek byl přidán.
  • Tento řádek byl odstraněn.
  • Formátování bylo změněno.

...

  • IPBX API - centralized API containing a wide range of management/configuration options

  • Local API (deprecated) - API running on each PBX, it will be a part of IPBX API in the future

1. Creating API

...

Access

You can create API access you can create in the IPEX Portal https://portal.voipex.io/.

In You choose API access in the section For Developer you choose API accessDevelopers.

...

Create You can create your API access to press by pressing the button in the top - right corner “Create access”.

...

You have need to fill these in this information:

  • E-mail - it is a user namewrite your username

  • Password - you can choose between custom or use generated, if needed, press the question mark to get help

  • Switchboard - select by clicking the arrow on the right

  • Impersonation - by checking impersonation allows you to access to all of the user’s Impersonation, you will get  access to all user's API functions and you can impersonate an a user .

  • - if you leave the box unchecked, accesses are you will only have access to the Rest api (calls log, switchboard)

...

Our API uses OAuth 2.0 password grant flow to allow you to access data from .. .

Obtaining tokena Token

Access The access token is obtained by making POST request to authorization endpoint https://auth.voipex.io/token. The post body must be formatted by using x-www-form-urlencoded.

...

curl -d "grant_type=password&client_id=api&username=<access_email>&password=<access_password>" -H "Content-Type: application/x-www-form-urlencoded" -X POST https://auth.voipex.io/token

Refreshing tokena Token

Access The access token is valid for 1 hour. After that time the client needs to obtain a new access token by using refresh_token and making aPOST request to authorization endpoint URL (https://auth.voipex.io/token). The post body for this specific method must also be also formatted by using x-www-form-urlencoded.

...