Uncanny Plugin Hub
Developer Documentation

Documentation

Welcome to Uncanny Dynamic Coupons Cloud

Comprehensive setup guide, architecture specifications, and troubleshooting reference for connecting your WooCommerce store to the Coupon Rank Engine.

Marketplace Compliance & Standards: Operating under official WooCommerce SaaS Extension guidelines, our service strictly evaluates coupon logic with zero customer PII storage. Review our Terms of Service and Privacy Policy for full compliance details.

1. Overview & How It Works

Uncanny Dynamic Coupons for WooCommerce connects your storefront to our cloud ranking infrastructure. Rather than slowing down your WordPress database with multiple cart recalculation loops when dozens of coupons exist, the plugin offloads comparison to our optimized ranking engine.

  • Single API Roundtrip: Evaluates all eligible coupons against cart contents in milliseconds.
  • Zero Checkout Impact: Hardened with a 3-second timeout and circuit-breaker. If the server is ever unreachable, the store checkout continues seamlessly.
  • 100% Compatible: Built for WooCommerce Cart and Checkout Blocks and Classic shortcodes, fully declared for High-Performance Order Storage (HPOS).

2. Step 1 — Create Your SaaS Account & Get an API Key

  1. Navigate to Create Account and register with your business email.
  2. Log in to your Merchant Dashboard.
  3. In the API Keys section, generate a new license key. Copy this key to your clipboard.

3. Step 2 — Install & Activate the Client Plugin

  1. In your WordPress Admin, go to Plugins → Add New.
  2. Upload the uncanny-dynamic-coupons-for-woocommerce.zip file and click Activate.
  3. Ensure WooCommerce (v8.0+) is installed and active.

4. Step 3 — Connect Your Store

  1. Go to WooCommerce → Settings → Products → Auto-Apply Coupons.
  2. Paste your license key into the License Key field.
  3. Click Activate Key.
  4. Upon successful connection, the badge updates to ACTIVE and the Enable auto-apply checkbox automatically unlocks.
  5. Check Enable auto-apply and click Save changes.

5. Customer Experience & Notices

  • Automatic Application: As soon as a customer adds qualifying items to their cart, the winning coupon is automatically applied.
  • Block Carts: Notices appear as non-intrusive snackbar notifications inside modern WooCommerce Cart and Checkout blocks.
  • Classic Carts: Notice renders cleanly at the top of the cart and auto-dismisses after 5 seconds without disrupting other WooCommerce notices.
  • Manual Override: If a customer manually enters a code that provides less savings than the auto-applied coupon, the plugin informs them and keeps the best discount active.

6. Technical Architecture & Endpoints

The client plugin communicates with the backend via three authenticated REST endpoints:

Method Endpoint Route Purpose
POST /wp-json/coupon-rank-engine/v1/activate Binds store URL to API key upon initial setup.
POST /wp-json/coupon-rank-engine/v1/deactivate Unbinds store URL when key is changed or removed.
POST /wp-json/coupon-rank-engine/v1/rank Evaluates candidate coupons in real time.

7. Troubleshooting & FAQ

Q: Why does the status badge show INACTIVE?
A: Ensure your server can make outbound HTTPS requests to autocoupon.uncannycs.com and that your license key balance is active.

Q: What happens if our store loses internet connectivity to the ranking engine?
A: The client plugin features a fail-closed circuit breaker. If requests time out (3 seconds), the plugin leaves existing cart coupons untouched and allows customer checkout to proceed without errors.

Notification