Download

The NFON Service Portal Application Programming Interface (API)

New: Postman Collection

  • NFON provides a comprehensive Postman Request collection which demos all available endpoints with more than 350 predefined request examples. It can be downloaded at the latest Service Portal API Postman Collection location (please right click and download as file) together with a Sample Postman environment.

  • Note: before filing a new support issue, please try out first the related request(s) with this collection and provide the Postman output with the support request. This allows us to better investigate your issue and further enhance this collection over time, so that we cover as many as possible usecases in that collection.

  • See below for more information on how to use this collection

Beta-Program

Support and availability of the API provided to customers as part of the BETA program are provided on a best-effort basis.
If you like to use the API you need to request an API key via the NFON support and is only available under the beta status. Before contacting NFON Support, please download one of the following documents, fill it out and provide it during your request to our Support Team:

The NFON API is available as a RESTful web service. NFON provides multiple APIs. The Service Portal API (SPA) is tailored to an Account-K level. Some Use Cases to illustrate the power of the Service Portal API (SPA) are

  • Mass extensions deployment

  • Active Directory interoperability

  • Interactive creation and management of conference bridges

  • Other third party management tools to automatically administer the PBX Account-K

Using the Postman Collection

  • Download the latest Service Portal API Postman Collection

    • You may have to right click on the link and choose "Download" or just save the shown page content to a file.

  • Download the latest Postman example environment

  • Install and Run Postman

    • Import the Service Portal API Collection into Postman.

    • Import the example environment similarly like the collection.

  • Edit the Environment

    • Important note: Use the "Current Value" column only. Be careful NOT to use the "Initial Value" column as it is shared into the Postman Cloud and you definitely do not want to share your API key to the cloud

    • Set the apiKey

    • Set the apiSecret

    • Set the customerId (Kxxxx, Sxxxx, Cxxxx)

    • Optionally: Set the baseUrl

  • Test the API

    • Go to General -> API Version and press "Send"

      • If you get a "403 Forbidden" then any of the environment variables are not correctly set or the environment has not been selected.

    • Try out Targets -> /api/customers/{{customerId}}/targets/

    • Your all set!

  • In case you have difficulties in using the collection, please contact your support.