Skip to content

SC-Networks/evalanche-soap-api-connector

Repository files navigation

EVALANCHE SOAP API CONNECTOR

Monthly Downloads License tests

Install

Via Composer

$ composer require scn/evalanche-soap-api-connector

PHP-Support

Connector-Version/Branch PHP-Version(s)
1.x 7.2, 7.3, 7.4, 8.0, 8.1
master 8.1, 8.2

Usage

General

First create a connection with the access credentials provided by SC-Networks.

require 'vendor/autoload.php';

$connection = \Scn\EvalancheSoapApiConnector\EvalancheConnection::create(
    'given host',
    'given username',
    'given password'
);

Then create the client of your choice e.g. FormClient

$statistic = $connection->createFormClient()->getStatistics(123, false);

Work with the results

$statistic->getImpressions()

Most of the methods will require/return structs which are defined and described in the struct repository.

Custom soapclient settings

EvalancheConnection::create allows to set custom settings for phps soap client. Please note that some options are predefined with meaningful values and cannot be changed.

$connection = \Scn\EvalancheSoapApiConnector\EvalancheConnection::create(
    'given host',
    'given username',
    'given password',
    false,
    [
        'keep_alive' => false,
    ]
);

Method Documentation

Can be found here. Detailled information about the calls can be found in the API documentation.

Testing

$ composer test

License

The MIT License (MIT). Please see License File for more information.