An open API service indexing awesome lists of open source software.

https://github.com/sc-networks/evalanche-soap-api-connector

Official PHP client for Evalanche SOAP API
https://github.com/sc-networks/evalanche-soap-api-connector

api connector evalanche php soap

Last synced: about 1 year ago
JSON representation

Official PHP client for Evalanche SOAP API

Awesome Lists containing this project

README

          

# EVALANCHE SOAP API CONNECTOR

[![Monthly Downloads](https://poser.pugx.org/scn/evalanche-soap-api-connector/d/monthly)](https://packagist.org/packages/scn/evalanche-soap-api-connector)
[![License](https://poser.pugx.org/scn/evalanche-soap-api-connector/license)](LICENSE.md)
![tests](https://github.com/SC-Networks/evalanche-soap-api-connector/workflows/tests/badge.svg)

## Install

Via Composer

``` bash
$ 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.

```php
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](https://github.com/SC-Networks/evalanche-soap-api-struct).

### Custom soapclient settings

`EvalancheConnection::create` allows to set [custom settings](https://www.php.net/manual/en/soapclient.construct.php)
for phps soap client. Please note that some options are predefined with meaningful values and cannot
be changed.

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

## Method Documentation

Can be found [here](/docs/index.md). Detailled information about the calls can be found in the [API documentation](https://help.evalanche.cloud/hc/en-us/sections/360003694531-Standard-API-SOAP-).

## Testing

``` bash
$ composer test
```

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.