Connectors / Service / Kibo

Kibo

Kibo

Kibo Commerce provides unified commerce products. It centralizes your technology and provides real-time customer insights.

Overview

Kibo is an extensible, unified commerce platform that delivers personalized, omnichannel experiences. Kibo's platform’s underlying technology powers unified commerce solutions, across B2C and B2B ecommerce, order management, and personalization.

API INFO: The Base URL used for the kibo connector is Your tenant URL. More information can be found on their main API documentation (v1.0) site.

Authentication

Within the workflow builder, highlight the Kibo connector.

In the Kibo connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

The next page asks you for your 'Tenant URL', 'Tenant ID', 'Application ID', 'Shared secret' and 'Site ID' credentials.

In order to get these fields, head to the Kibo dashboard. Click on the 'Develop' tab and choose 'Applications'. If you don't already have an application, please create one.

This will auto populate the 'Shared secret' but you would need to define the 'Application ID' manually.

To get the 'Tenant ID', head to the 'Sandboxes' tab and create a new sandbox environment. This will auto populate a 'Sandbox ID' which will act as the 'Tenant ID' for your application.

To get the 'Tenant URL' and the 'Site ID', once the status of the sandbox changes to active, then click on the Cog icon on the right of the sandbox name, under the 'Actions' column and click on 'View'.

This will take you to your site where you can get the 'Tenant URL' as well as the 'Site ID' from the URL. The 'Site ID' will be defined at the end of the URL after -s (for site), in this case, Admin/s-12345. The Tenant URL is configured in the following format: https://t{Tenant ID}.{Host}.mozu.com. For example, if your Tenant ID is 54321 and your environment is a sandbox then your 'Tenant URL' will be https://t54321.sandbox.mozu.com

PLEASE NOTE: In order to connect your applications to the environment you would need to install the applications. Simply go to the Sandboxes tab and click on Install App

Once you have added these fields to your Tray.io authentication popup window, click the 'Create authentication' button.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Notes on using Kibo

Create order

You may create an order without sending any request data, however, there are more than 100 optional fields available from the Kibo API. By visiting the Kibo documentation you can define properties and their data types. For example, say we want add a gift message to our order. Going through the API documentation we can find that giftMessage belongs to the shopperNotes property (the dot notation defines a child property of an object e.g. shopperNotes.giftMessage).

In the Tray workflow, set the operation to 'Create order' and click on 'Add property to Request properties'. Set the name of the property to 'shopperNotes'.

Change the data type to be an object.

Now we need to add the child property giftMessage. Follow the steps above but this time add the property to shopperNotes instead. According to the Kibo API, giftMessage must be a string so update the data type accordingly. Now type in your desired gift message.

By running the workflow you can check the result. Open the Debug panel to view your step's output.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a very powerful feature which you can put to use when there is an endpoint in Kibo which is not used by any of our operations.

To use this you will first of all need to research the endpoint in the Kibo API documentation v1.0, to find the exact format that Kibo will be expecting the endpoint to be passed in.

Note that you will only need to add the suffix to the endpoint, as the base URL will be automatically set (the base URL is picked up from the value you entered when you created your authentication).

The base URL for Kibo is: Your Tenant URL

For example, say that the 'List events' operation did not exist in our Kibo connector, and you wanted to use this endpoint. You would use the Kibo API docs to find the relevant endpoint - which in this case is a `GET` request called: `/api/event/pull`.

More details about this endpoint can be found here.

As you can see there is also the option to include a query parameter, should you wish to do so. So if you know what your method, endpoint and details of your query parameters are, you can get the Event information with the following settings:

Method: `GET`

Endpoint: `/api/event/pull`

Query Parameter: Key: `pageSize` Value: `1`

Final outcome being: /api/event/pull?pageSize=1

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our Managing data best practices guide.

All Operations

Latest version:

1.0