Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Adding the RESTful Application to a device requires that you have the RESTful Application Module module installed along with a valid license.  To To purchase the RESTful Application module, please see this wiki on how to Purchase Commercial Modules.  You You will also need to make sure you have a valid Commercial End Point Manager module and the Free Commercial RESTful API module installed.

Once all the above requirement requirements are met you can go through the below setup.

...

  1. Verify the user you will be adding this application to has been setup as a an API user in the RESTful API module and that they have access to either all modules or at the very least the module that the application will be using.
     
  2. Log into your Phone phone's PBX Admin GUI and click on the module called RestAPI.

     
  3. On the right is a list of users who have a RESTful API account setup.  Click Click on your user or if you do not see the user listed, click the "New Token" option.

     
  4. When you edit or setup a API user you can set the following options.
    1. Name- A name for this user.  Usually the extension number.
    2. Description-  Optional description about this API user 
    3. Associated User- Which Extension/User you want this key to be associated with.  If the extension is deleted the key will also be removed.  Also the status of the API Key can be enabled and disabled in the User Control Panel of the associated user along wth their API Tokens.
    4. Status- Enable or Disabled
    5. Users- Which user(s) data this token key can get and set.  Meaning if we were using the API token here for Do No Disturb the API token would only work to receive and set DND for these users.  Only set to the users you want this API token to be able to control and ususally is the same as the Associated User above.
    6. Modules- Which modules this users token has access to.  Default is to set this to "All" modules.
    7. Rate Limit- How many request per hour this token user can make.

       
  5. Once done save your settings.

...