API Reference

Axxess

Axxess ISP provides a comprehensive API to order numerous products, including:

• Mobile Data
• Fibre Combos
• ADSL Data
• ADSL Lines
• Axxess Voice (VoIP)
• Fixed Wireless

API Manual

The Axxess API PDF can be downloaded here.

Source Code

The Axxess API is also provided as a single PHP file called resellerAPIbootstrap.php.

Cybersmart

Cybersmart provides an API to do most things Cybersmart related. They have a cool reseller demo of what’s possible, and also provides a link to download the sample source code.

Noticably absent from the source code is anything fibre related. Although the online demo has an Add Telkom FTTH Account menu, this API call does not exist in the source code.

DirectAdmin

DirectAdmin is a control panel recommended by ZADomains.

• https://www.directadmin.com/api.php

Internet Solutions

addAccount (JSON 3.2)

Used to add a new LTE account.

Request

{
  "Username": "MyUsername",
  "Realm": "domain.co.za",
  "Password": "ExamplePassword",
  "Package": "lte-cellc-50g",
  "LTE Device": "B618",
  "Delivery Details": {
    "Contact": {
      "Name": "Joe Rest",
      "ID Number": "8134464656565",
      "Cell": "0836547912",
      "Day Number": "0836547912",
      "Email": "email@example.com"
    },
    "Address": {
      "Building": "Unit 19",
      "Street": "45 Street Road",
      "Suburb": "Sandton",
      "City": "Johannesburg",
      "PostCode": "2190"
    },
    "RICA": {
      "Building": "Unit 19",
      "Street": "45 Street Road",
      "Suburb": "Sandton",
      "City": "Johannesburg",
      "PostCode": "2190"
    },
    "Instructions": "Deliver instruction for courier"
  }
}

Response

{
  "ok": true,
  "data": {
    "Request ID": 118
  }
}

• The Request ID should be stored as this is used to track or cancel the order.

PHP Example

<?php
$provisioning->request_id = $result->data->{'Request ID'};

cancelOrder (JSON 3.5)

Cancel a undelivered new order.

An order can only be cancelled prior to the courier sending the package for delivery.

Sample request

{
  "Request ID": 121
}

Sample response

{
  "ok": true,
  "data": null
}

deleteAccount (JSON 3.8)

Delete an active LTE account.

Please refer to the reason codes table for possible reason codes.

Remember to URL encode your parameter strings.

Sample request

/rest/lte/deleteAccount.php?username=user1@domain&reason_code=3

Sample response

{
  "ok": true,
  "data": null
}

getAccountInfo (SOAP 5.2.7)

This procedure will return an array containing the given broadband account’s information.

The Status field mapping

Reason Codes (JSON 4)