juliogarcia/engaged-api

dev-master 2017-08-10 17:25 UTC

This package is not auto-updated.

Last update: 2024-05-03 18:50:05 UTC


README

Engaged API with all the API Calls described

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

  • API version: 1.0.0
  • Build package: 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//.git"
    }
  ],
  "require": {
    "/": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new Swagger\Client\Api\GameApi();
$api_key = new \DateTime("2013-10-20"); // \DateTime | API-KEY defined in the header.
$game_id = 3.4; // float | Game ID.

try {
    $result = $api_instance->aPIKEYGameGAMEIDStatsGet($api_key, $game_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GameApi->aPIKEYGameGAMEIDStatsGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://1b282yiqu3.execute-api.us-west-2.amazonaws.com/prod

Class Method HTTP request Description
GameApi aPIKEYGameGAMEIDStatsGet GET /{API_KEY}/game/{GAME_ID}/stats Retrieve All Stats by Game ID
GameApi gameAllStatsGet GET /game/all/stats Retrieve All Stats

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author