Dreamscape Reseller REST API allows you quickly and easily integrate with our system. At the moment, the REST API provides the following capabilities:

1. management of customers;
2. management of Domain names;
3. management of Hosting products (Web Hosting, Email Hosting, Servers, etc.);
4. management of all the other products (SSL Certificate, Site Builder, Simple SEO, etc.);
5. financial stuff: balance, invoices;
6. various handbooks (list of currencies, list of TLDs with pricing, etc.).

To facilitate integration with REST API there is the Sandbox server. Using it you can test the all API methods. Sandbox server is analogous to a real server, but at the same time it is completely isolated and all actions performed on it do not affect the real server: real domains are not registered, money is not deducted from the account, etc. Read more about it in Sandbox section.

The Dreamscape Reseller REST API is available at the following URL:

https://reseller-api.ds.network

We have prepared a page where you can see the full list of available API methods with a list of input parameters and examples of requests and responses. Also, you can try out all requests using that page.

Find & test all API calls here

In case you need to develop your custom integration with the REST API, use the following instructions:

1. Find out Reseller API Key.

   To find Reseller API Key go to Reseller Console > Account Settings > API & WHMCS > API Setup.

2. Generate Request ID. It must be MD5-hash and be unique for each request to avoid sending it twice if it was intercepted.

   You have the right to choose how to control the uniqueness. The main thing that it must be md5-hash.

   $request_id = md5(uniqid() . microtime(true)); // 7fd755f2390745071051fca4924831cd

3. Create a signature which is an md5-hash from the concatenation of Request ID and API Key of the reseller.

   $api_key = '202cb962ac59075b964b07152d234b70';
   $signature = md5($request_id . $api_key); // 774d61236130b6ae545240613aca2716

4. Specify the HTTP headers.

   Api-Request-Id: 7fd755f2390745071051fca4924831cd
   Api-Signature: 774d61236130b6ae545240613aca2716

This section contains examples of generating a signature and sending a request to Dreamscape Reseller REST API in some programming languages.

PHP

Download the ZIP-archive with examples for PHP programming language by following this link.

<?php

$api_key = '068d0a67ab617dc0d8a7f1481e8ae91d';
$request_id = md5(uniqid() . microtime(true));
$signature = md5($request_id . $api_key);
$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => 'https://reseller-api.ds.network/domains/availability?domain_names[]=crazydomains.com.au&domain_names[]=vodien.com',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Api-Request-Id: ' . $request_id,
        'Api-Signature: ' . $signature,
    ],
]);

echo 'Response: ' . curl_exec($ch);

curl_close($ch);

Node.js

const fetch = require('node-fetch');
const crypto = require('crypto');

function md5(data) {
    return crypto.createHash('md5')
        .update(String(data))
        .digest('hex');
}

async function main() {
    const api_key = '068d0a67ab617dc0d8a7f1481e8ae91d';
    const request_id = md5(Date.now());
    const signature = md5(request_id + api_key);

    try {
        const url_search = 'domain_names[]=crazydomains.com.au&domain_names[]=vodien.com';
        const request = await fetch('https://reseller-api.ds.network/domains/availability?' + url_search, {
            method: 'GET',
            headers: {
                'Accept': 'application/json',
                'Api-Request-Id': request_id,
                'Api-Signature': signature,
            },
        });

        console.log('Response data:', await request.json());
    } catch (e) {
        console.error(e);
    }
}

main().catch(e => console.error(e));

Reseller API PHP SDK - a library for interacting with the Reseller REST API using PHP programming language which provides a convenient and easy interface.
Using this library you will get the following features:

1. call all the Reseller REST API methods;
2. manipulate with data with use of objects instead of array;
3. autocompletion for objects for all the entities in the IDE (domains, customers, products, etc);
4. exception-based handling of errors;
5. logging of requests, etc;

Download Reseller API PHP SDK Documentation

Sandbox is an isolated environment in which you can conduct your experiments. Performing actions in the sandbox does not affect the real account in any way. This means that funds will not be debited from your real balance, but it allows to order a test domains, products, etc in sandbox environment. The next services are presented in Sandbox:

1. Reseller Console - https://reseller.sandbox.ds.network
2. Dreamscape Reseller REST API - https://reseller-api.sandbox.ds.network

Notes:

1. Sandbox credentials (login, password) are the same as for production environment.
2. Reseller REST API is absolutely the same as for production. The Sandbox REST API server is available in the API methods Documentation, so you can test it here.