Configure Connector for Netsapiens, RingLogix, United Cloud, Viirtue

The instructions provided here represent the final step in the PBX configuration process - configuring the Advanced Settings.

To complete the setup successfully, ensure that the initial steps have been followed. You can find those steps here: PBX Configuration Guide.

Overview

Enterprises have two options for configuring their Netsapiens PBX instance:

1. Manual Entry – Provide all required API credentials from scratch.

2. Template-Based Setup – Use an API Credentials Template, if one has been supplied by the Service Provider.

Configuration behavior depends on how the Service Provider has set up the template:

- If modifications are restricted, all necessary API credentials and configuration details are assumed to be pre-filled and validated by the reseller.

- If certain fields are left blank, the Enterprise Administrator must complete the remaining configuration to finalize the PBX setup.

This flexible approach supports both guided and manual setup workflows, while maintaining control over sensitive credential management.

Note to the Service Provider

Refer to this article: Manage API Credentials Templates at the Reseller Level - for Netsapiens, RingLogix, United Cloud and Viirtue

Before You Begin

• For an introduction on the 2 sets of Nestapiens API credentials used in ConnecttoTeams, please check Introduction to API v1 for API and SSO - for Netsapiens, RingLogix, United Cloud, Viirtue

Populate the Fields in Advance Settings Tab

1. Ensure that the initial steps in PBX Configuration Guide have been followed.

2. Go to the Advanced Settings tab.
   

3. Supply the values for the fields in API Integration Settings section. The API credentials to save here is to be used for configuring PBX users, devices and placing PBX calls.
   
   If you're using a template provided by the Service Provider, some fields may be locked and not editable, depending on the restrictions set by the provider.

   
   Ensure that all editable fields are fully completed to finalize the configuration. The fields are:
   
   - API Access Token URL : The NS PBX URL to request auth token. Format is often https://<domain>/ns-api/oauth2/token
   - NS API Access Client ID : The ID to be sued to get an auth token.
   - NS API Access Client Secret : The auth secret associated with the API Access Client ID. 
   - NS API Access Username : The username of the PBX user used to retrieve an auth token. The user must have access to all users and devices in the domain, as such, must have a user scope of Office Manager at a minimum.
   - NS API Access Password : The password associated with the API Access Username.
   
   
   
   Click the Test Connection this button to the correctness of the supplied API credentials. Change the values until the test gives you a success indicator.

4. Supply values for the fields in End User Portal Settings section. The API credentials to save here is used to facilitate single sign-on (SSO) of Teams User to the Netsapiens Web Portal.

   
   If you're using a template provided by the Service Provider, some fields may be locked and not editable, depending on the restrictions set by the provider.

   
   Note:  Wherever presented, use “Copy … from above” links if wanting to copy/paste values from API Integration Settings section above.
   
   Ensure that all editable fields are fully completed to finalize the configuration. The fields are:
   - Portal Access Token URL : The NS URL to get auth toke. This is usually in the form of https://<domain>/ns-api/oauth2/token
   - Portal SSO Provider : Select NATIVE. The CUSTOM only if you have prior arrangement for custom PBX configurations.
   - End User Portal URL : The NS Portal URL to load when SSO fails for some reason. Format is often https://<domain>/portal
   - Portal SSO URL : The NS URL for SSO login. Format is often https://<domain>/portal/login/loginwithtoken?iframe=yes
   - Client ID for SSO : The ID to be used to access a token.

   - Client Secret for SSO : The secret associated with Client ID for SSO.
   - Masquerading User for SSO : PBX user to retrieve a token on behalf of another User. Should be of higher scope than Basic User. The user must have access to all users and devices in the domain, as such, must have a user scope of Office Manager at a minimum.
   - Password for Masquerading User : The password of the Masquerading User for SSO.
   

   

5. Select Save Settings when you have completed the form.