Skip to main content

Authorization

Follow this guide to create a new Kibo API credential that will allow Nexla to authenticate to and exchange data with your Kibo Commerce account.
kibo_api_auth.png

Kibo API

Prerequisites

Before creating a Kibo API credential, you need to obtain OAuth2 credentials (Client ID and Client Secret) from your Kibo Commerce account. The OAuth2 credentials are required for 2-legged OAuth2 authentication with the Kibo Commerce API.

To obtain your OAuth2 credentials, you need to have a Kibo Commerce account and access to the Kibo Commerce developer portal or account settings. Once you have access, you can create an application or obtain OAuth2 credentials from your account settings. The Client ID and Client Secret are used for 2-legged OAuth2 authentication, which uses the client credentials flow to obtain an access token. This authentication method is suitable for server-to-server communication where user interaction is not required. The access token is then sent in the Authorization header with the Bearer prefix for all API requests to the Kibo Commerce API. The Kibo Commerce API provides access to e-commerce data including products, orders, carts, customers, and inventory information. For detailed information about OAuth2 credential setup, authentication flows, and available API endpoints, refer to the Kibo Commerce API documentation and Kibo Commerce API authentication guide.

Create a Kibo API Credential

  • To create a new Kibo API credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Kibo API

KiboCred.png

Credential Name & Description

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

OAuth2 Authentication

Kibo Commerce API uses 2-legged OAuth2 authentication with the client credentials flow. This authentication method is designed for server-to-server communication where user interaction is not required. The Client ID and Client Secret are used to obtain an access token, which is then used to authenticate API requests to the Kibo Commerce API.

  1. Enter your Kibo API Client ID in the Client ID field. This is the Client ID you obtained from your Kibo Commerce account settings or developer portal. The Client ID is a unique identifier for your application and is used along with the Client Secret to obtain an access token for API authentication. The Client ID is not sensitive and can be shared, but it should be kept secure to prevent unauthorized use.

  2. Enter your Kibo API Client Secret in the Client Secret field. This is the Client Secret you obtained from your Kibo Commerce account settings or developer portal. The Client Secret is used along with the Client ID to obtain an access token for API authentication. The Client Secret is sensitive information and must be kept confidential.

    Keep your Client Secret secure and do not share it publicly. The Client Secret provides access to your Kibo Commerce account data and should be treated as sensitive information. If your Client Secret is compromised, you should immediately regenerate it in your Kibo Commerce account settings. Your Kibo API Client Secret can be found in your Kibo Commerce account settings or developer portal where you manage your application credentials. The Client Secret is used along with the Client ID to obtain an access token using the 2-legged OAuth2 client credentials flow. The access token is obtained from the /api/platform/applications/authtickets/oauth endpoint. Nexla automatically obtains and refreshes the access token as needed. The access token does not expire automatically, but you can regenerate credentials if needed. For detailed information about finding your Client Secret, setting up OAuth2 credentials, and managing access tokens, see the Kibo Commerce API documentation.

Save the Credential

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.