NSPS configuration

• PortaBilling/PortaSwitch version MR100 or later with enabled External system provisioning framework (ESPF)
• An active subscription to the NSPS module in the Add-on Mart

To configure PortaBilling to send webhook events to NSPS via HTTP, configure an EventSender handler and subscribe it to a specific category of events (e.g., SIM card events).

For this, log in to PortaBilling and perform the following steps:

1.1 Navigate to Infrastructure > Event handlers

1.2 Click +Event handler and fill in the General details:

• Name – specify the handler name, e.g., NSPS
• Type – select EventSender
• Enabled – select the checkbox
• Events version – select Events v.2 (default value) to use simplified provisioning events. You can select the Events v.1 if the required v.2 events are not available in your current system version.
• Concurrency – specify the number of concurrent task processing. The default value is “1”.
• AsyncMode – leave this checkbox selected to send requests asynchronously (a handler sends a request as soon as it is processed, without waiting for a reply from a server). If you clear the checkbox, the requests will be sent synchronously (one by one once a server reply is received).
• AuthMethod – select Basic (to authenticate by user ID and password).
• BasicAuth.Key – specify the user password required for the basic HTTP authentication.
• BasicAuth.User – specify the username required for the basic HTTP authentication.

  

• URL – leave this field blank for now. When NSPS is deployed, obtain the URL of the NSPS inbound listener (dispatcher) from PortaOne support and enter it here.

Next, switch to the Event subscriptions tab and select the relevant event category, such as “SIM,” or individual events.

1.3 Click Save.

NSPS requires API user credentials to retrieve the data from PortaBilling via the API. The credentials are specified in the NSPS Configuration UI. 

To create a new API user, log in to PortaBilling and perform the following steps:

2.1 Navigate to My company > Access control > Users

2.2 Click +Add and fill in the user details:

• Login – type the username that will be used by NSPS for connecting to the PortaBilling API;
• Email – type in the email address of the admin (for receiving alerts or password recoveries for the user);
• Password – type a long and strong password for this user;
• Role – select a role for this user. 
  Ensure the selected role has no restrictions on the entities that require data access. It’s recommended to create a dedicated admin role with “Read” permissions for the following entities:

  • Customer > Account
  • SIM card
  • Product
  • Service policy
  • Bundle > Configuration > Thresholds
• Click Save.

  

2.3 Open the user record and navigate to Web self-care, and enable the API token access.

2.4 Click Save.

Once the configuration in PortaBilling is completed, you can configure and deploy NSPS.

Log in to the Add-on Mart management portal, locate your NSPS subscription, and click Configure.

On the NSPS Configuration UI page that opens, fill in the configuration details and click Deploy (or Save for later to deploy it later).

The form on the Configuration UI consists of the following blocks:

• System configuration
• PortaBilling configuration

Fill in the parameters that are needed to send events to NSPS through HTTP webhooks and access the NSPS web UI:

• ESPF username – specify the username required for the HTTP authentication (specified in the BasicAuth.User field at step 1.2).
• ESPF password – specify the user password for the HTTP authentication (specified in the BasicAuth.Key field at step 1.2).
• Admin username – specify the login of the admin user for accessing the NSPS web UI. This user can then create additional accounts in the NSPS web UI.
• Admin password – specify the password for accessing the NSPS web UI.
• The Google Cloud Platform (GCP) region where the system will be deployed – select a GCP region that is closest to your PortaBilling installation (to minimize the latency).

Fill in the parameters that are needed for NSPS to connect to the PortaBilling API:

• PortaBilling API host – specify the URL or IP address where the PortaBilling admin web interface is hosted (https://<IP or hostname>/rest).
• PortaBilling API username – specify the admin user login created in step 2.2.
• PortaBilling API token – specify the token created in step 2.2.

Click Deploy.