semuxgo/semux-php

Semux PHP SDK

Semux PHP SDK

Semux PHP SDK aims to provide necessary utilities for web developers to create 3rd party web services connecting to Semux Wallet. Currently the only supported feature is an API client.

Table of Contents

• Requirements
• Installation
• Getting Started
• Documentation
• Examples
• Tests
• Maintainers
• License

Requirements

PHP 5.6 and later

Installation

To install the SDK via Composer, run:

composer require semuxproject/semux-php

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure base URL and HTTP basic authorization of Semux API Server
$config = new Semux\Client\Configuration();
$config->setHost("http://localhost:5171/v2.0.0")
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$semuxApi = new Semux\Client\Api\SemuxApi(
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $semuxApi->getInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SemuxApi->getInfo(): ', $e->getMessage(), PHP_EOL;
}

Documentation

https://semuxproject.github.io/semux-php/Semux/Client/Api/SemuxApi.html

Examples

• Create wallets
• Transfer coins

Tests

To run the unit tests:

docker-compose -f .travis/docker/docker-compose.yml up -d && .travis/wait-for-it.sh -h 0.0.0.0 -p 5171 -t 30 -s && sleep 15
composer install
cp phpunit.xml.dist phpunit.xml
./vendor/bin/phpunit

Maintainers

@cryptokat.

License

MIT © The Semux Developers