@klevu/indexing

Klevu's Indexing API is an advanced tool designed to enhance catalog management for e-commerce merchants. This package provides an easy-to-use function createKlevuClient for integrating Klevu's Indexing API into your e-commerce platform, allowing for efficient operations on a wide range of items in your store catalog, including products, categories, content pages, and other entity types.

Features

Simplifies integration with Klevu's Indexing API. Enables operations on various catalog items. Supports custom entity types based on business needs.

Installation

Install the package using npm:

npm install @klevu/indexing

Usage

To use the package, import and initialize the client with your API key and REST key:

const { createKlevuClient } = require('@klevu/indexing');

const client = createKlevuClient('your_api_key', 'your_rest_key', options);

Options

The createKlevuClient function can accept an optional options object for additional configuration.

Examples

Here's a basic example of how to use the client:

const { createKlevuClient } = require("@klevu/indexing")

async function main() {
  const api = createKlevuClient(API_KEY, REST_KEY, {
    logger: true,
  });

  const listAttributesResponse = await api.listAttributes();
  console.log({ listAttributesResponse });
}
main()

For more information, refer to the Klevu Indexing API documentation.

API Reference

For a complete list of available methods and their descriptions, please refer to the Klevu Indexing API documentation.

Contributing

Contributions to improve the package are welcome. Please follow the contribution guidelines in the repository.

License

This package is licensed under MIT.

Support

For support, please contact [email protected].