Platform Documentation
The complete developer guide to deploying Akmond Notify for VTU platforms, e-commerce, and custom software architectures.
1. VTU Integration Guide
Akmond Notify provides two robust integration pathways. Choose the one that matches your technical environment:
Option A: Zero-Code Database Monitor
Best for standard Topupmate or non-technical owners. The Akmond Sentinel Engine securely watches your tables and detects failed transactions instantly.
Step 1: Link Your Database
Connect via Direct MySQL (requires IP whitelist) OR use our Secure HTTP Bridge file if your host blocks remote SQL.
Step 2: Map the Sentinel
- Inside your Dashboard, navigate to Remote DB Mapping.
- Select your connection type and input your credentials.
- Scroll to Map Transaction Table and select a quick-preset (e.g., Topupmate Failed Transactions) or map your columns manually.
- Click Activate Engine Rules. The Sentinel is now live!
Option B: Instant API Webhooks
Built for developers. Trigger alerts exactly when transactions fail within your code execution.
Step 1: Obtain Secret Key
Generate your akm_live_... API Bearer token from the Developer API Hub.
Step 2: Install PHP Helper
Add this drop-in function to your script's core logic:
function send_akmond_alert($secret_key, $message, $phone = '') {
$ch = curl_init('https://notify.akmondpay.com/api/v1/send.php');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_TIMEOUT, 3);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
'recipient' => $phone,
'message' => $message
]));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $secret_key,
'Content-Type: application/json'
]);
$res = curl_exec($ch); curl_close($ch);
return $res;
}
2. WooCommerce Plugin Guide
Deploy automated WhatsApp order receipts and shipping updates to your WordPress store in minutes.
- Log into your Akmond Dashboard and navigate to the Developer API Hub ⚡.
- Click Generate API Key and securely copy your
akm_live_...secret. - Click the Download Plugin (.zip) button on the hub page.
- In your WordPress Admin Panel, go to Plugins → Add New → Upload Plugin and select the downloaded file.
- Activate the plugin, then click on Akmond Notify in your WordPress sidebar settings.
- Paste your Secret Key and save. Your store is now fully automated!
3. Universal REST API
Trigger instant messaging workflows from any custom software architecture (Node.js, Python, Ruby, PHP). Ideal for B2C 2FA OTP deliveries, IoT system alerts, and custom receipt dispatching.
Core Endpoint
Required Headers
- Content-Type: application/json
- Authorization: Bearer YOUR_AKMOND_LIVE_SECRET
API Payload Example: Sending OTPs
curl -X POST "https://notify.akmondpay.com/api/v1/send.php" \
-H "Authorization: Bearer akm_live_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{
"recipient": "2348012345678",
"message": "🔐 *Your Login OTP*\n\nCode: *849201*\n\nExpires in 10 mins. Do not share this code."
}'
const axios = require('axios');
async function sendOTP(customerPhone, code) {
const payload = {
recipient: customerPhone,
message: `🔐 *Your Login OTP*\n\nCode: *${code}*\n\nExpires in 10 mins. Do not share.`
};
const res = await axios.post('https://notify.akmondpay.com/api/v1/send.php', payload, {
headers: { 'Authorization': 'Bearer akm_live_YOUR_KEY' }
});
console.log(res.data);
}