fbpx
25 Mar 2015

How to setup iPlum APIs for getting automatic usage logs?

iPlum REST API


iPlum provides REST APIs for automatically downloading call and message logs to an external server. Developers can use iPlum APIs to download the usage activity and associate them to their users to get visibility and compliance at an organization.

Every account gets free 30 days trial period to setup the account and start using the API. After that it is inexpensive just like other iPlum products, only $2 per user per month. There is no limitation or metering on the number of records pulled. You can start or stop the service any time. There is no long-term contract.

Setup iPlum API:

  1. Login into iPlum console and select “Utilities >> iPlum API” on the left menu bar.

  2. In the center of the page, Enable API Access Status using the button. The system will ask permission to proceed. Click “Yes”.

  3. Important: You will be presented your Secret Key only once. Download your API Access Key & Secret Key and store at a secure location. If you lose the secret key, you must generate a new key and reset the process.

  4. You will use the key pair to pull iPlum usage logs. Click “Close”.

  5. Callbacks: iPlum can put usage logs directly to your server without having to pull them via API calls. You still need to setup the above process in order to enable the capabilities:

    1. Click “Edit” icon.

    2. Enable “Usage Callback” by toggle button.

    3. Check the type of Callbacks you want to enable.

    4. Select Integrator: Select the built-in iPlum integrator or your Custom configuration. If you selected Custom configuration, please enter your Callback URL. If you enable authentication, add a username and password which you want our servers to use when placing Callback data on your servers.

    5. Save Settings.

    6. You will start receiving usage logs real-time.


If you have any questions, you can always Contact us