Splynx API

The bigger business, the bigger amount of customizations and integrations it requires. Splynx provides an easy way to create additional modules or integrate it with 3rd-party software solutions. Our system is a powerful set of modules and open application interfaces (API), which is why we call it a Framework. For administrators, this means almost unlimited possibilities for software customization.

We follow the RESTful principles, so the API is stateless and http methods and response codes are used whenever possible.

 


The links for API documentation:

Splynx API Documentation

Repository with PHP API Class for Splynx ISP Framework


 

PHP Api example

<?php
/**
 * Splynx API v.1.0 demo script
 * Author: Ruslan Malymon (Top Net Media s.r.o.)
 * https://splynx.com/wiki/index.php/API - documentation
 */

include 'SplynxApi.php';

$api_url = 'http://splynx/'; // please set your Splynx URL

$key = "3d052b922dc2f44d1d03d957ff5691ba"; // please set your key
$secret = "4d944c2d4d55bd78a1af0f6b8d5958af"; // please set your secret

// don't forget to add permissions to API Key, for changing locations.

$api = new SplynxAPI($api_url, $key, $secret);

$locationsApiUrl = "admin/administration/locations";

print "<pre>";

print "List locations\n";
$result = $api->api_call_get($locationsApiUrl);
print "Result: ";
if ($result) {
    print "Ok!\n";
    print_r($api->response);
} else {
    print "Fail! Error code: $api->response_code\n";
    print_r($api->response);
}
print "\n-------------------------------------------------\n";

print "Create location\n";
$result = $api->api_call_post($locationsApiUrl,
    array(
        'name' => 'API test #' . rand()
    ));

print "Result: ";
if ($result) {
    print "Ok!\n";
    print_r($api->response);
    $locationId = $api->response['id'];
} else {
    print "Fail! Error code: $api->response_code\n";
    print_r($api->response);
    $locationId = false;
}
print "\n-------------------------------------------------\n";

if ($locationId) {

    print "Retrieve location " . $locationId . "\n";
    $result = $api->api_call_get($locationsApiUrl, $locationId);
    print "Result: ";
    if ($result) {
        print "Ok!\n";
        print_r($api->response);
    } else {
        print "Fail! Error code: $api->response_code\n";
        print_r($api->response);
    }
    print "\n-------------------------------------------------\n";


    print "Change created location name\n";
    $result = $api->api_call_put($locationsApiUrl, $locationId, array('name' => 'NAME CHANGED #' . mt_rand()));
    print "Result: ";
    if ($result) {
        print "Ok!\n";
        print_r($api->response);
    } else {
        print "Fail! Error code: $api->response_code\n";
        print_r($api->response);
    }
    print "\n-------------------------------------------------\n";

    print "Retrieve updated info\n";
    $result = $api->api_call_get($locationsApiUrl, $locationId);
    print "Result: ";
    if ($result) {
        print "Ok!\n";
        print_r($api->response);
    } else {
        print "Fail! Error code: $api->response_code\n";
        print_r($api->response);
    }
    print "\n-------------------------------------------------\n";

    print "Delete created location\n";
    $result = $api->api_call_delete($locationsApiUrl, $locationId);
    print "Result: ";
    if ($result) {
        print "Ok!\n";
        print_r($api->response);
    } else {
        print "Fail! Error code: $api->response_code\n";
        print_r($api->response);
    }
    print "\n-------------------------------------------------\n";

}

 


Should you have any questions or further information is needed, please contact us or schedule a call with our engineer.

QuickBooks Integration

Watch The Video How Splynx Can Be Integrated with Quickbooks Software

Fill in the contact form below to get more information about our products and license conditions:

Quickbooks Integration

Watch The Video How Splynx Can Be Integrated with Quickbooks Software

Fill in the contact form below to get more information about our products and license conditions:

Social Login to Splynx Portal

We would like to share with you information about one more our feature. Right now clients of ISP that is using Splynx have an opportunity to sign in to the Splynx customer portal using their social networks account. There ISP subscribers can find information about Internet usage statistics, phone calls, invoices, pay their invoice online, change their existing or order new service.

They don’t have to remember their username and passwords to their ISP portal. Our social login feature supports three the most popular social networks:

1. Facebook

Nowadays Facebook is the most popular social network worldwide. Right now it has more than two billion of active users and it definitely contains most of your clients.

Facebook

2. Google+

Google+ is not very a popular social network, but your clients need to have just Google account to log into Splynx customer portal. There are more than billion active users of google accounts right now and this number is growing.

Google

3. Twitter

Twitter is known as the real-time microblogging social network where news appear first. It has more than 300 million of active users and it is widely used by active people around the world.

Google

So as far as we see it is a very useful feature, which can improve your clients’ user experience. Let’s make life simpler!

Please, watch the video with the detailed overview of this feature below:

SEPA XML export

The Single Euro Payments Area (SEPA) is a payment-integration initiative of the European Union for simplification of bank transfers denominated in euro. Splynx is able to export invoices to SEPA, and can import after payments to set invoices as paid, or in case that payments were returnes, to se that invoices as unpaid. Read More