Skip to main content

​
Phase 1: Backend Configuration (REST API)

This step allows Kleep to retrieve your product catalog, order history, and return/refund data to calibrate the algorithm.

​
1. Create a REST API Key

  1. Log in to your WordPress Admin Panel.
  2. Navigate to WooCommerce > Settings > Advanced > REST API.
  3. Click on “Add key”.
  4. Fill in the following fields:
    • Description: Enter a name (e.g., “Kleep Integration”)
    • User: Select an admin user
    • Permissions: Select Read
  5. Click “Generate API key”.

​
2. Retrieve and Save Credentials

After generating, WooCommerce will display two credentials:
  • Consumer Key (starts with ck_)
  • Consumer Secret (starts with cs_)
⚠️ Important: The Consumer Secret is only shown once. Copy both values immediately and store them securely.

​
3. Requirements

  • Your WooCommerce store must use HTTPS for the API keys to work securely.
  • WooCommerce REST API version v3 is required (WooCommerce 3.5+).
  • If you use custom return/RMA plugins (e.g., YITH WooCommerce RMA, ReturnGO), please let us know so we can coordinate the right integration approach.

​
4. Firewall Configuration

If your store is behind a firewall or uses IP-based access restrictions, please whitelist the following Kleep IP addresses to ensure uninterrupted API access:
  • 34.1.4.3
  • 82.66.252.201
  • 176.148.67.162

​
5. Send Credentials to Kleep

Please send the following information to your Kleep contact via email:
  1. Your store URL (e.g., https://yourstore.com)
  2. Consumer Key (ck_...)
  3. Consumer Secret (cs_...)

​
Phase 2: Frontend Integration (Widget)

This step involves adding the Kleep script to your product pages (PDP). Compatible with all versions of WooCommerce. Follow our JS Library Widget guide to install and configure the front-end CTA on your product pages.

​
Phase 3: Missing Data Management (SFTP)

This section applies when data cannot be retrieved through standard API endpoints. If your WooCommerce store uses a third-party returns/RMA plugin that does not expose return data through the standard WooCommerce REST API, we proceed via CSV file exchange. Please refer to the documentation below. This guide will walk you through the process of transmitting missing data step by step. Please focus on the return data part.

​
Cookies & data privacy

Kleep is fully gated by visitor consent: the script only loads after consent is collected through your CMP, and you must condition its loading accordingly. For the complete list of trackers, the data processed, the purposes and legal bases, hosting, subprocessors and security, see Cookies, CMP & Data Privacy.