Skip to main content

Kibo API Data Source

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 ingests data from a Kibo API location.
kibo.png

Kibo API

Follow the instructions below to create a new data flow that ingests data from a Kibo API source in Nexla.

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 Kibo API connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Kibo Commerce account, and click Next; or, create a new Kibo API credential for use in this flow.

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

    Kibo API sources can also be configured manually, allowing you to ingest data from Kibo Commerce API 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 Kibo Commerce API endpoints. Each template is designed specifically for the corresponding Kibo Commerce API 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.

    Get Cart Summary

    Retrieves the number of items in the active cart, total cost of items in the cart and the cart expiration.

    • Optionally, enter the Tenant ID in the Tenant Id field. This is the unique identifier for your Kibo Commerce tenant. The Tenant ID is used to construct the API endpoint URL for your specific tenant instance.
    • Optionally, enter the Site ID in the Site Id field. This is the unique identifier for a specific site within your Kibo Commerce tenant. The Site ID is used to construct the API endpoint URL for your specific site.
    • Optionally, enter the Environment in the Environment field. This specifies the Kibo Commerce environment (e.g., sandbox, production) to use. The environment is used to construct the API endpoint URL.
    • The endpoint uses GET requests to https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/carts/summary where {tenantId}, {siteId}, and {env} are the values you configured. The endpoint URL is automatically constructed based on the values you specify.
    • The endpoint does not use pagination (iteration.type: static.url) and returns a single response. The response data path is $, which extracts the entire response object.
    • The date format is yyyy-MM-dd with a time unit of dd (days), which is used for incremental data extraction based on record dates.

    This endpoint retrieves cart summary information from your Kibo Commerce account. The endpoint requires 2-legged OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. The endpoint URL is dynamically constructed based on your tenant ID, site ID, and environment settings. The cart summary includes information about the number of items in the cart, total cost, and cart expiration time. For detailed information about cart summaries, API endpoints, and response formats, see the Kibo Commerce API documentation.

Configure Manually​

Kibo Commerce API data sources can be manually configured to ingest data from any valid Kibo Commerce 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 Kibo Commerce API sources, such as sources that use custom query parameters, different HTTP methods, or custom data transformations.

Content Format​

  1. Select the format in which the data from the Kibo Commerce API will be received from the Content Format pulldown menu. Nexla will automatically parse the data in the selected format. The Kibo Commerce API typically returns data in JSON format.

API Endpoint URL​

  1. Enter the URL of the Kibo Commerce API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Kibo Commerce API endpoints typically follow the pattern https://t{tenantId}-s{siteId}.{env}.mozu.com/api/{endpoint_path} or use the base URL pattern for your specific tenant and site configuration.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires 2-legged OAuth2 authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. The endpoint URL may need to include your tenant ID, site ID, and environment in the domain structure. For detailed information about Kibo Commerce API endpoints, authentication, and available APIs, see the Kibo Commerce API documentation.