Skip to main content

Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Porta Billing location.
porta_billing_api.png

Porta Billing

Create a Porta Billing Destination​

  1. Click the + icon on the Nexset that will be sent to the Porta Billing destination, and select the Send to Destination option from the menu.

  2. Select the Porta Billing connector from the list of available destination connectors. Then, select the credential that will be used to connect to your Porta Billing account, and click Next; or, create a new Porta Billing credential for use in this flow.

  3. In Nexla, Porta Billing destinations can be created using pre-built endpoint templates, which expedite destination setup for common Porta Billing endpoints. Each template is designed specifically for the corresponding Porta Billing endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Porta Billing destinations can also be configured manually, allowing you to send data to Porta Billing endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Porta Billing endpoints. Each template is designed specifically for the corresponding Porta Billing endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    Create resource

    This endpoint template creates a resource of a given type in your Porta Billing account using records from a Nexset. Use this template when you need to create new resources such as customers, accounts, or other service resources in your Porta Billing account.

    • Enter the service name in the Service field. This should be the service name where you want to create the resource (e.g., Customer, Account). The service determines which Porta Billing service will receive the resource.
    • Enter the service endpoint in the Service endpoint field. This should be the endpoint that can be invoked on the selected service to create the resource (e.g., add_batch, create). The service endpoint determines which specific endpoint will be called on the selected service.

    This endpoint sends data as JSON in the request body to create resources in your Porta Billing account. Each record from your Nexset will be sent as a separate API request to create a new resource in Porta Billing. The request body should contain the resource data in the format required by the Porta Billing API.

    The resource structure must match the Porta Billing API's expected format for the selected service and service endpoint. For detailed information about resource creation, request body formats, available services, and resource management, see the Porta Billing API documentation.

Configure Manually​

Porta Billing destinations can be manually configured to send data to any valid Porta Billing API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Porta Billing API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Porta Billing API from the Method pulldown menu. Porta Billing API typically uses POST method for creating resources.

Data Format​

  1. Select the format in which the Nexset data will be sent to the Porta Billing API from the Content Format pulldown menu. Porta Billing API expects JSON format for all requests.

API Endpoint URL​

  1. Enter the URL of the Porta Billing API endpoint to which data will be sent in the URL field. This should be the complete URL to your Porta Billing endpoint (e.g., https://akweb.portaone.com:443/rest/Customer/add_batch). Include any required path parameters in the URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. The Porta Billing API endpoint URL should point to the endpoint where you want to create resources. The endpoint URL should include the service and service endpoint path. You can test the endpoint using the Test button after configuring the URL.

Request Body​

  1. Configure the request body that will be sent to the Porta Billing API. The request body should contain the resource data formatted as JSON, with field names matching the Porta Billing API's expected structure. The request body format is typically {message.json} to send the entire Nexset data as JSON, or you can construct a custom JSON structure with specific field mappings.

The request body must be valid JSON and must match the Porta Billing API's expected format for the specific service and service endpoint you're using. Porta Billing API uses specific structures for different services (Customer, Account, etc.). For detailed information about request body formats, available endpoints, and resource structures, see the Porta Billing API documentation.

Save the Destination​

  1. Once all of the relevant steps in the above sections have been completed, click the Next button to proceed with the rest of the data flow configuration, or click Save to save the destination configuration for later use.