REST API

The REST API module allows you to integrate Siteadda Labs with external applications, websites, and services. You can send messages, manage contacts, retrieve session status, and more through simple HTTP requests.

1. Enable the REST API Server

   Navigate to REST API → Settings tab and enable the REST API server. Configure the port (default: 3000) and other settings as needed.

2. Generate an API Key

   Go to the API Keys tab, select a device, and click "Generate" to create a new API key for that device.

3. Test the API

   Use the Documentation tab to test API endpoints directly from the interface. Each endpoint has a "Test Now" button for quick testing.

4. Integrate with Your Application

   Use the generated API key in your application's HTTP requests to interact with Siteadda Labs.

API keys are device-specific and provide secure access to the REST API. Each key is associated with a single WhatsApp device.

Generating API Keys

1. Navigate to REST API → API Keys tab
2. Select a device from the dropdown menu
3. Click the "Generate" button
4. Copy the generated API key immediately (it won't be shown again)
5. Store the API key securely in your application

1. Send Message

{
  "phone": "1234567890",
  "message": "Hello from Siteadda Labs!"
}

2. Send Media

{
  "phone": "1234567890",
  "mediaUrl": "https://example.com/image.jpg",
  "caption": "Check this out!",
  "mediaType": "image"
}

3. Send Buttons

{
  "phone": "1234567890",
  "message": "Choose an option:",
  "buttons": [
    {"id": "1", "text": "Option 1"},
    {"id": "2", "text": "Option 2"}
  ]
}

4. Get Session Status

5. List Groups

All API requests must include your API key in the request headers:

X-API-Key: your-api-key-here

Example Request (cURL)

curl -X POST http://localhost:3000/api/send-message \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your-api-key-here" \
  -d '{
    "phone": "1234567890",
    "message": "Hello from Siteadda Labs!"
  }'

JavaScript (Node.js)

const axios = require('axios');

const sendMessage = async () => {
  try {
    const response = await axios.post(
      'http://localhost:3000/api/send-message',
      {
        phone: '1234567890',
        message: 'Hello from Siteadda Labs!'
      },
      {
        headers: {
          'X-API-Key': 'your-api-key-here',
          'Content-Type': 'application/json'
        }
      }
    );
    console.log('Message sent:', response.data);
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
};

sendMessage();

Python

import requests

url = 'http://localhost:3000/api/send-message'
headers = {
    'X-API-Key': 'your-api-key-here',
    'Content-Type': 'application/json'
}
data = {
    'phone': '1234567890',
    'message': 'Hello from Siteadda Labs!'
}

response = requests.post(url, json=data, headers=headers)
print('Response:', response.json())

PHP

<?php
$url = 'http://localhost:3000/api/send-message';
$data = array(
    'phone' => '1234567890',
    'message' => 'Hello from Siteadda Labs!'
);

$options = array(
    'http' => array(
        'header'  => "Content-Type: application/json\r\n" .
                     "X-API-Key: your-api-key-here\r\n",
        'method'  => 'POST',
        'content' => json_encode($data)
    )
);

$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
echo $result;
?>

The API returns standard HTTP status codes and JSON error messages:

Error Response Format

{
  "success": false,
  "error": "Error message description",
  "code": "ERROR_CODE"
}

Common Issues

If you encounter any issues or have questions about the REST API:

• Check the built-in Documentation tab for interactive API testing
• Review the application logs for detailed error messages
• Visit the Troubleshooting page for common solutions
• Contact Siteadda Labs support for technical assistance