Brightery Woo-Order-Api

Açıklama

Connecting WooCommerce to customer service chatbots shouldn’t require exposing your entire store to complex webhook setups or granting full read/write API access.

Brightery Woo-Order-Api acts as a secure, read-only bridge. It provides two highly specific API endpoints tailored exactly to what chatbots need: order statuses and tracking links.

It is perfectly suited for developers building automated customer support flows on platforms like ManyChat, Chatfuel, Dialogflow, or custom AI agents.

Features

  • Secure API Key Authentication: Easily generate an API key from the WordPress admin dashboard to ensure only your bot can access the data.
  • Targeted Data: Exposes only the necessary data (order status, shipping dates, courier, tracking links) without leaking sensitive customer information.
  • Search by Email or Phone: Allows bots to query a user’s purchase history using their contact information.
  • Order Verification: The specific order endpoint requires the billing email to match the order ID, adding an extra layer of privacy.

API Endpoints

Base URL: https://your-site.com/wp-json/Brightery-api/v1

1. Get Specific Order (Ideal for “Where is my order?” flows)
* GET /order/{order_id}?email=customer@example.com

2. Get Customer Order History
* GET /orders/by-contact?phone=1234567890
* GET /orders/by-contact?email=customer@example.com

Authentication: All requests must include the header: X-Brightery-API-Key: YOUR_API_KEY

Yükleme

  1. Upload the plugin files to the /wp-content/plugins/brightery-woo-order-api directory, or install the plugin through the WordPress plugins screen directly.
  2. Activate the plugin through the ‘Plugins’ screen in WordPress.
  3. Navigate to WooCommerce > Bot API Settings in your WordPress admin menu.
  4. Copy the generated API Key or create your own, and click “Save”.
  5. Provide the API endpoints and the API Key to your bot developer or integrate them into your chatbot platform via HTTP requests.

SSS

Does this require the default WooCommerce REST API to be enabled?

No. This plugin creates its own independent, isolated endpoints specifically for bot tracking.

How do I authenticate my bot?

Go to WooCommerce > Bot API Settings to find your API key. Pass this key in the headers of your bot’s HTTP request as X-Brightery-API-Key.

Will this expose customer credit card details?

Absolutely not. The API is strictly read-only and only returns the order ID, shipping company, shipping date, order status, and tracking link.

İncelemeler

Bu eklenti için herhangi bir değerlendirme bulunmuyor.

Katkıda Bulunanlar ve Geliştiriciler

“Brightery Woo-Order-Api” açık kaynaklı yazılımdır. Aşağıdaki kişiler bu eklentiye katkıda bulunmuşlardır.

Katkıda bulunanlar

Değişiklik Kaydı

1.0.0

  • Initial release.
  • Added endpoint to query order by ID and email.
  • Added endpoint to query order history by phone or email.
  • Added API key generation and header authentication for enhanced security.