README.md

axxell-client-php

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/CINAQ/Axxell.git"
    }
  ],
  "require": {
    "CINAQ/Axxell": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/axxell-client-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: ApiKey
Axxell\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Axxell\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new Axxell\Api\DefaultApi();
$storeid = "storeid_example"; // string | Store identifier
$event_type = "event_type_example"; // string | Valid values purchase, view or recommend
$data_period = "data_period_example"; // string | Valid values are last7days, last30days, today, yesterday

try {
    $result = $api_instance->aggregateCountEvents($storeid, $event_type, $data_period);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->aggregateCountEvents: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://axxell.cinaq.com/v1/

Class	Method	HTTP request	Description
DefaultApi	aggregateCountEvents	GET /aggregates/countevents/{eventType}
DefaultApi	aggregateEffective	GET /aggregates/effective/{eventType}
DefaultApi	aggregateEvents	GET /aggregates/events/{eventType}
DefaultApi	aggregateRecent	GET /aggregates/recent/{eventType}
DefaultApi	aggregateTop	GET /aggregates/top/{eventType}
DefaultApi	authStore	POST /auth
DefaultApi	deleteAllEvents	DELETE /events
DefaultApi	deleteAllItems	DELETE /items
DefaultApi	deleteItem	DELETE /items/{itemid}
DefaultApi	recommendInteresting	GET /recommendations/interesting
DefaultApi	recommendSimilar	GET /recommendations/similar
DefaultApi	registerEvent	POST /events
DefaultApi	registerItem	POST /items
DefaultApi	registerStore	POST /store
DefaultApi	retrieveEvents	GET /events
DefaultApi	retrieveItems	GET /items

Documentation For Models

• DataPoint
• ErrorResponse
• Event
• Item
• Store

Documentation For Authorization

ApiKey

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author

Auto generated, see https://github.com/cinaq/axxell-specifications