MTN API Gateway Platform User Guide

Complete installation, configuration and usage guide for the MTN API Gateway Platform.

Introduction

Welcome to the MTN API Gateway Platform. This platform provides a centralized solution for MTN Data Sharing, Data Gifting, Data Transfer, Customer Authorization, Transaction Status Monitoring, and Notification Callbacks.

It is designed for developers, telecom businesses, VTU providers, resellers, and organizations that require automated MTN data management services.

System Requirements
  • PHP 7.4 or Higher
  • MySQL 5.7 or Higher
  • Apache or Nginx
  • SSL Certificate (Recommended)
  • cURL Extension Enabled
  • JSON Extension Enabled
  • Internet Connectivity
Installation Guide
Step 1: Upload Files

Upload the entire project folder to your server.

public_html/
└── mtn-platform/
                

Step 2: Create Database
Database Name: mtn_platform
Username: mtn_user
Password: ********
                

Step 3: Configure Database

Open:

config/database.php
                

Update the database settings:

$db_host = "localhost";
$db_name = "mtn_platform";
$db_user = "username";
$db_pass = "password";
                

Step 4: Configure MTN Settings

Open:

config/mtn.php
                

Configure your MTN credentials:

define('MTN_CLIENT_ID','YOUR_CLIENT_ID');
define('MTN_CLIENT_SECRET','YOUR_SECRET');
define('MTN_API_URL','https://api.example.com');
                

Step 5: Run Installer
https://yourdomain.com/install.php
                

The installer will create the database tables, default settings and administrator account.


Step 6: Login
https://yourdomain.com/admin/login.php
                
Dashboard Overview
Dashboard

Statistics & Overview

Transactions

Transaction Monitoring

Logs

System Activities

Settings

Platform Configuration

Supported MTN Services
1. Authentication
Secure MTN API authentication and token management.
2. Customer Authorization
Verify customer permissions before processing requests.
3. Customer Data Share
Add consumers to MTN Data Share groups.
4. Customer Data Gifting
Gift MTN data bundles to another subscriber.
5. Customer Data Transfer
Transfer data allocations between subscribers.
6. Transaction Status Check
Monitor transaction processing status.
7. Notification Callback
Receive automated MTN transaction notifications.
Transaction Workflow
Customer Request
       ↓
Authentication
       ↓
Authorization
       ↓
MTN Processing
       ↓
Response Received
       ↓
Status Verification
       ↓
Callback Notification
       ↓
Transaction Logging
                
Troubleshooting
Authentication Failed
  • Invalid Credentials
  • Expired Credentials
  • MTN Service Downtime
Invalid Request
  • Missing Parameters
  • Invalid JSON Format
  • Incorrect MSISDN Format
Callback Not Received
  • Incorrect Callback URL
  • SSL Problems
  • Firewall Restrictions
Security Recommendations
  • Use HTTPS for all API traffic.
  • Protect administrator credentials.
  • Use strong passwords.
  • Backup your database regularly.
  • Monitor transaction logs frequently.
  • Restrict access using firewall rules where possible.

Disclaimer

This platform depends on third-party services and APIs which may change, become unavailable, or be restricted without notice.

The developer does not guarantee uninterrupted operation and shall not be liable for any losses, damages, business interruption, service disruption, or financial losses resulting from the use of this software.

Support Information
Developer

Godwin

WhatsApp

09080008483