๐Ÿš€ Quick Access

โš™๏ธ Configuration

Set up API keys and credentials in WordPress admin

๐Ÿ“Š API Status

Check system health and test endpoints

๐Ÿ” ID Finder

Find User and Product IDs for API calls

๐Ÿ” Authentication

โš ๏ธ Required for all API calls

All endpoints require your Banimal Master API Key in the request header:

X-Banimal-Api-Key: your_master_api_key_here

How to get your key: Configure it in Banimal โ†’ Configuration in your WordPress admin panel.

๐Ÿ“ก API Endpoints

POST /wp-json/banimal/v1/automated-supply

Automated Supply Chain

Initializes the automated supply chain ecosystem, creates data folders, and syncs with configured storage services.

What it does:

  • Creates ecosystem data folder in WordPress uploads
  • Initializes ecosystem_data.json file
  • Syncs with Google Drive (if configured)
  • Pushes to GitHub repository: fruitful-global-planet
  • Sends to backend API endpoint
  • Triggers configured webhooks

Example Request:

curl -X POST https://banimal.co.za/wp-json/banimal/v1/automated-supply \ -H "X-Banimal-Api-Key: your_master_key"
POST /wp-json/banimal/v1/process-payment

Process Payment

Initialize payment transactions through configured payment gateways.

Parameters:

  • gateway - Payment gateway (default: paystack)
  • amount - Amount in cents (default: 1000)
  • email - Customer email
  • reference - Transaction reference

Example Request:

curl -X POST https://banimal.co.za/wp-json/banimal/v1/process-payment \ -H "X-Banimal-Api-Key: your_master_key" \ -H "Content-Type: application/json" \ -d '{ "gateway": "paystack", "amount": 5000, "email": "customer@example.com", "reference": "order_12345" }'
POST /wp-json/banimal/v1/woocommerce/webhook

WooCommerce Webhook Handler

Receives WooCommerce order completion notifications and logs transactions.

โ„น๏ธ Setup Required

Configure this webhook in WooCommerce โ†’ Settings โ†’ Advanced โ†’ Webhooks

  • Topic: Order Updated
  • Delivery URL: https://banimal.co.za/wp-json/banimal/v1/woocommerce/webhook
  • Set webhook secret in Banimal Configuration

๐ŸŒ Supported Integrations

๐Ÿ’ณ Payment Gateways

Paystack
Stripe
PayPal
Payfast
Flutterwave
M-Pesa
Square
Alipay

๐Ÿ›’ E-Commerce Platforms

WooCommerce
AliExpress
Alibaba

โ˜๏ธ Cloud Storage & Sync

Google Drive
GitHub
Cloudflare R2
Custom Backend API

๐Ÿค– AI & Other Services

OpenAI
Webhooks

๐ŸŒ Multilingual Support

๐ŸŽ‰ NEW: Global Language Support

The Banimal Ecosystem Connector now supports multiple languages! The plugin automatically adapts to your WordPress language settings.

โœ… Currently Available Languages

๐Ÿ‡บ๐Ÿ‡ธ English
๐Ÿ‡จ๐Ÿ‡ณ ็ฎ€ไฝ“ไธญๆ–‡ (Chinese Simplified)

๐Ÿ”œ Coming Soon

๐Ÿ‡ช๐Ÿ‡ธ Espaรฑol (Spanish)
๐Ÿ‡ซ๐Ÿ‡ท Franรงais (French)
๐Ÿ‡ฉ๐Ÿ‡ช Deutsch (German)
๐Ÿ‡ง๐Ÿ‡ท Portuguรชs (Portuguese)
๐Ÿ‡ท๐Ÿ‡บ ะ ัƒััะบะธะน (Russian)
๐Ÿ‡ฏ๐Ÿ‡ต ๆ—ฅๆœฌ่ชž (Japanese)
๐Ÿ‡ฐ๐Ÿ‡ท ํ•œ๊ตญ์–ด (Korean)
๐Ÿ‡ธ๐Ÿ‡ฆ ุงู„ุนุฑุจูŠุฉ (Arabic)
๐Ÿ‡ฎ๐Ÿ‡ณ เคนเคฟเคจเฅเคฆเฅ€ (Hindi)
๐Ÿ‡ฐ๐Ÿ‡ช Kiswahili (Swahili)
๐Ÿ‡ฟ๐Ÿ‡ฆ isiZulu (Zulu)
๐Ÿ‡ฟ๐Ÿ‡ฆ Afrikaans

๐ŸŽฏ How to Change Language

  1. Log into your WordPress admin
  2. Go to Settings โ†’ General
  3. Select your preferred Site Language
  4. Click Save Changes
  5. The Banimal plugin will automatically display in your chosen language!

๐Ÿค Want to Contribute a Translation?

We're looking for translators to help make Banimal accessible worldwide! If you're fluent in any of the languages above, we'd love your help.

Contact: translations@banimal.co.za

Contributors receive credit in the plugin, a link to their profile, and early access to new features.

๐ŸŽฏ Getting Started

โœ… Quick Setup (5 minutes)
  1. Log into your WordPress admin at banimal.co.za/wp-admin
  2. Navigate to Banimal โ†’ Configuration
  3. Enter your Banimal Master API Key
  4. Add at least one payment gateway (e.g., Paystack)
  5. Click Save Configuration
  6. Go to Banimal โ†’ API Status
  7. Click Test Supply Chain to verify setup
  8. Use Banimal โ†’ ID Finder to locate User and Product IDs for API calls

๐Ÿ” Finding User and Product IDs

To connect your data using the Banimal API, you need the right WordPress IDs. Use the interactive ID Finder tool in your WordPress admin: Banimal โ†’ ID Finder

๐Ÿ‘ค Finding a User ID

  1. In the WordPress sidebar, click on Users โ†’ All Users.
  2. Find the user you need and hover over their name.
  3. Look at the bottom left of your browser (or the address bar when you click Edit). You'll see the URL.

EXAMPLE URL:

yoursite.com/wp-admin/user-edit.php?user_id=123&wp_http_referer=...

๐Ÿ“ฆ Finding a Product ID

  1. In the WordPress sidebar, click on WooCommerce โ†’ Products (or just Products).
  2. Find the product you need and hover over its name.
  3. Look at the bottom left of your browser (or the address bar when you click Edit). You'll see the URL.

EXAMPLE URL:

yoursite.com/wp-admin/post.php?post=456&action=edit

๐Ÿ’ก Pro Tip

This ID number is what you'll use in your API calls to connect user or product data to the Banimal ecosystem. For a visual, interactive guide, visit Banimal โ†’ ID Finder in your WordPress admin.

๐Ÿ“ค Response Examples

Success Response:

{ "message": "Automated supply chain initiated successfully", "timestamp": "2025-10-27 11:30:00" }

Error Response:

{ "message": "Error: Unauthorized access", "code": "invalid_api_key" }

๐Ÿ”— External Webhooks

Configure external webhook URLs in Banimal โ†’ Configuration to receive ecosystem updates.

โ„น๏ธ Webhook Format

Enter comma-separated URLs:

https://hook1.example.com,https://hook2.example.com

Your endpoints will receive POST requests with ecosystem data in JSON format.

๐Ÿ”’ Security Features

  • Encrypted Storage: All API keys encrypted using WordPress AUTH_KEY
  • Request Authentication: Master API key required for all operations
  • Webhook Verification: HMAC signature validation for WooCommerce webhooks
  • Input Sanitization: All user inputs validated and sanitized
  • SQL Injection Protection: WordPress prepared statements
  • XSS Protection: All outputs properly escaped

๐Ÿ’ฌ Support & Documentation

๐Ÿ“š User Manual

Comprehensive guide with setup instructions, troubleshooting, and examples

๐Ÿ†˜ Technical Support

Email: support@banimal.co.za
Include: WordPress version, PHP version, error messages

๐ŸŒ Website

Visit banimal.co.za for updates, news, and additional resources

๐ŸŒ Translations

Help translate to your language
Email: translations@banimal.co.za

๐Ÿ“ What's New

๐ŸŽ‰ Version 4.7.9 - October 27, 2025 (Current)

NEW: Multilingual Support!

  • Complete internationalization framework
  • Chinese Simplified (็ฎ€ไฝ“ไธญๆ–‡) translation available
  • Easy language switching via WordPress settings
  • Translation template ready for community contributions
  • 150+ UI strings fully translatable
  • Support for 12+ additional languages coming soon

Version 4.7.8 - October 27, 2025

  • Added interactive ID Finder tool
  • Visual guide for finding User and Product IDs
  • Improved user experience for API integration
  • Enhanced documentation

Version 4.7.7

  • Added sidebar menu with Banimal icon
  • Configuration page for API keys
  • API Status dashboard with testing tools
  • Enhanced security with encryption
  • Multiple payment gateway support
  • WooCommerce webhook integration
  • Automated supply chain management
  • Cloud storage synchronization