scn/evalanche-soap-api-connector

Official PHP client for Evalanche SOAP API

v1.13.1 2024-08-05 12:05 UTC

Requires

• php: >=7.2
• ext-soap: *
• scn/evalanche-soap-api-struct: ^2.0
• scn/hydrator: ^2|^3
• scn/hydrator-property-values: ^2.0|^3.0

Requires (Dev)

• php: >=7.3
• friendsofphp/php-cs-fixer: ^3.0
• phpstan/phpstan: ^1.4
• phpstan/phpstan-strict-rules: ^1.1
• phpunit/phpunit: ^9

MIT

• Sascha Nützel
• Daniel Jakob

• api
• soap
• email marketing
• connector
• evalanche

README

Install

Via Composer

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

PHP-Support

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.