Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Porta Billing source in Nexla.
porta_billing_api.png

Porta Billing

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Porta Billing connector tile from the list of available 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 data sources can be created using pre-built endpoint templates, which expedite source setup for common Porta Billing endpoints. Each template is designed specifically for the corresponding Porta Billing endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

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

Configure Using a Template​

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

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    List resources

    This endpoint template lists resources from your Porta Billing account. Use this template when you need to retrieve information about various resources such as currencies, customers, or other service endpoints from your Porta Billing account.

    • Enter the service name in the Service field. This should be the service name you want to query (e.g., Currency, Customer). The service determines which Porta Billing service will be queried.
    • Enter the service endpoint in the Service endpoint field. This should be the endpoint that can be invoked on the selected service (e.g., get_currency_list, get_batch_list). The service endpoint determines which specific endpoint will be called on the selected service.

    This endpoint lists resources from your Porta Billing account using the specified service and service endpoint. The endpoint uses offset-based pagination to handle large datasets efficiently. Nexla will automatically fetch subsequent pages of data by incrementing the offset. The endpoint returns up to 100 records per page by default.

    For detailed information about resource listing, API response structures, pagination, and available services, see the Porta Billing API documentation.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Porta Billing data sources can be manually configured to ingest data from 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.

With manual configuration, you can also create more complex Porta Billing sources, such as sources that use chained API calls to fetch related data or sources that require custom query parameters or filters.

API Method​

  1. To manually configure this source, 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 retrieving data from endpoints.

API Endpoint URL​

  1. Enter the URL of the Porta Billing API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL to your Porta Billing endpoint (e.g., https://akweb.portaone.com:443/rest/Currency/get_currency_list). 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 uses offset-based pagination with offset and limit for most endpoints. The endpoint URL should include the service and service endpoint path. You can test the endpoint using the Test button after configuring the URL.

Response Data Path​

  1. Enter the JSONPath expression in the Response Data Path field to specify which part of the API response should be treated as the relevant data by Nexla. For Porta Billing API responses, use $.[*] to extract all items from the response array, or $ to extract the entire response for single record endpoints, depending on your endpoint.

The JSONPath expression must correctly reference the structure of your Porta Billing API response. Porta Billing API responses may have different structures depending on the endpoint. Ensure your JSONPath expression matches the structure returned by your specific endpoint. The JSONPath expression determines which data will be extracted and processed by Nexla.

Pagination (if applicable)​

  1. If your endpoint supports pagination, configure the pagination settings in the Pagination section. Porta Billing API uses offset-based pagination with offset and limit for most endpoints. Select the pagination type that matches your endpoint's pagination mechanism.

  2. Configure the pagination parameters based on your selected pagination type. For offset-based pagination, specify the offset parameter name (offset), the starting offset value, and the page size parameter name (limit).

Save the Data Source​

  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 data source configuration for later use.