DataMart API Documentation

To access the DataMart API, you'll need an API key. Include it in your request headers as:

X-API-Key: your_api_key_here

API Key Management

You can manage your API keys using the following endpoints:

POST /api/developer/generate-api-key

{
  "name": "My API Key",
  "expiresIn": 365  // Optional: Days until expiry
}

GET /api/developer/api-keys

DELETE /api/developer/api-keys/:id

POST https://datamartbackened.onrender.com/api/developer/purchase

Endpoint to purchase mobile data for a phone number

Request Body:

{
  "phoneNumber": "0551234567",  // Recipient's phone number
  "network": "TELECEL",         // Network identifier (see options below)
  "capacity": "5",              // Data capacity in GB
  "gateway": "wallet"           // Payment method (default: wallet)
}

Supported Networks:

• TELECEL - Vodafone Ghana
• YELLO - MTN Ghana
• AT_PREMIUM - AirtelTigo Ghana

Success Response (201):

{
  "status": "success",
  "data": {
    "purchaseId": "60f1e5b3e6b39812345678",
    "transactionReference": "TRX-a1b2c3d4-...",
    "network": "TELECEL",
    "capacity": "5",
    "mb": "5000",
    "price": 23.00,
    "remainingBalance": 177.00,
    "geonetechResponse": { ... }
  }
}

Error Response:

{
  "status": "error",
  "message": "Error message description",
  "details": { ... }  // Optional additional details
}

To get available data packages for a specific network, use the GET /api/developer/data-packages endpoint:

GET /api/developer/data-packages?network=TELECEL

Response:

{
  "status": "success",
  "data": [
    {
      "capacity": "5",
      "mb": "5000",
      "price": "23.00",
      "network": "TELECEL"
    },
    {
      "capacity": "10",
      "mb": "10000",
      "price": "35.50", 
      "network": "TELECEL"
    },
    // More packages...
  ]
}

You can also get packages for all networks at once:

GET /api/developer/data-packages

Response (All Networks):

{
  "status": "success",
  "data": {
    "TELECEL": [
      // Vodafone packages
    ],
    "YELLO": [
      // MTN packages
    ],
    "AT_PREMIUM": [
      // AirtelTigo packages
    ]
  }
}

Test the Data Purchase API with your own API key:

Next.js Example:

// pages/api/purchase-data.js
import axios from 'axios';

export default async function handler(req, res) {
  if (req.method !== 'POST') {
    return res.status(405).json({ message: 'Method not allowed' });
  }

  const { phoneNumber, network, capacity } = req.body;
  
  // Validate required fields
  if (!phoneNumber || !network || !capacity) {
    return res.status(400).json({ 
      message: 'Missing required fields' 
    });
  }

  try {
    const response = await axios.post(
      'https://datamartbackened.onrender.com/api/developer/purchase',
      {
        phoneNumber,
        network,
        capacity,
        gateway: 'wallet'
      },
      {
        headers: {
          'Content-Type': 'application/json',
          'X-API-Key': process.env.DATAMART_API_KEY
        }
      }
    );

    return res.status(201).json(response.data);
  } catch (error) {
    console.error('DataMart API Error:', error.response?.data || error.message);
    
    return res.status(error.response?.status || 500).json({
      message: 'Failed to purchase data bundle',
      details: error.response?.data || error.message
    });
  }
}

Node.js Example:

// data-service.js
const axios = require('axios');

class DataMartService {
  constructor(apiKey) {
    this.apiKey = apiKey;
    this.baseUrl = 'https://datamartbackened.onrender.com/api/developer';
    this.httpClient = axios.create({
      baseURL: this.baseUrl,
      headers: {
        'Content-Type': 'application/json',
        'X-API-Key': this.apiKey
      }
    });
  }

  async purchaseData(phoneNumber, network, capacity) {
    try {
      const response = await this.httpClient.post('/purchase', {
        phoneNumber,
        network,
        capacity,
        gateway: 'wallet'
      });
      
      return response.data;
    } catch (error) {
      console.error('DataMart API Error:', error.response?.data || error.message);
      throw error;
    }
  }

  async getDataPackages(network = null) {
    try {
      const url = network ? `/data-packages?network=${network}` : '/data-packages';
      const response = await this.httpClient.get(url);
      
      return response.data;
    } catch (error) {
      console.error('Failed to fetch data packages:', error.response?.data || error.message);
      throw error;
    }
  }
}

module.exports = DataMartService;

Python Example:

# datamart_client.py
import requests

class DataMartClient:
    def __init__(self, api_key):
        self.api_key = api_key
        self.base_url = 'https://datamartbackened.onrender.com/api/developer'
        self.headers = {
            'Content-Type': 'application/json',
            'X-API-Key': api_key
        }
    
    def purchase_data(self, phone_number, network, capacity):
        """Purchase a data bundle for the specified phone number."""
        url = f"{self.base_url}/purchase"
        payload = {
            'phoneNumber': phone_number,
            'network': network,
            'capacity': capacity,
            'gateway': 'wallet'
        }
        
        response = requests.post(url, json=payload, headers=self.headers)
        response.raise_for_status()  # Raise exception for 4XX/5XX responses
        
        return response.json()
    
    def get_data_packages(self, network=None):
        """Get available data packages, optionally filtered by network."""
        url = f"{self.base_url}/data-packages"
        if network:
            url += f"?network={network}"
        
        response = requests.get(url, headers=self.headers)
        response.raise_for_status()
        
        return response.json()

# Usage example
if __name__ == "__main__":
    client = DataMartClient("your_api_key_here")
    
    # Get MTN data packages
    mtn_packages = client.get_data_packages("YELLO")
    print(mtn_packages)
    
    # Purchase data bundle
    result = client.purchase_data("0551234567", "TELECEL", "5")
    print(result)