README

Deprecation of the Channel API client libraries

This library is no longer supported by ChannelEngine. To build your own library via OpenAPI Generator, using your programming language of choice, check out the Channel API: API clients article in our Help Center.

ChannelEngine’s APIs follow the OpenAPI/Swagger specifications, which you can find in our API reference. (At the top of the swagger page switch to 'ChannelEngine Channel API')

Additional information for developers

For detailed information on ChannelEngine’s APIs, go to the REST APIs category in our Help Center.

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "require": {
    "channelengine/channel-api-client-php": "*"
  }
}

Then run composer install

Getting Started

Please follow the installation procedure and then run the following:

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

use ChannelEngine\ApiClient\Configuration;
use ChannelEngine\ApiClient\ApiException;
use ChannelEngine\ApiClient\Api\OrderApi;

$apiConfig = Configuration::getDefaultConfiguration();
$apiConfig->setHost('https://demo.channelengine.net/api');
$apiConfig->setApiKey('apikey', 'xxxxxxxxxxxx');

$orderApi = new OrderApi(null, $apiConfig);

try {
	$response = $orderApi->orderGetNew();
	dd($response);
} catch (ApiException $e) {
	// In case of a non-2xx status an exception will be trown.
	// However, we can check getResponseBody() to get the deserialized response.
	echo($e->getMessage());
	dd($e->getResponseBody());
}

function dd($var) {
	echo("<pre>");
	print_r($var);
	echo("</pre>");
}

channelengine / channel-api-client-php

Maintainers

Details