bravecollective/neucore-api

Client library of Neucore API

1.6.0 2019-11-12 20:27 UTC

This package is auto-updated.

Last update: 2020-01-12 20:50:52 UTC


README

The version numbers correspond to the Neucore version numbers.

When updating, check the generator version in .openapi-generator/VERSION, a new version may break backwards compatibility.

Breaking changes

  • 1.4.0:
    Generated from OpenAPI v3 definition file.
    The authorization configuration changed, use setAccessToken() instead of setApiKey(), see below.

OpenAPIClient-php

Client library of Neucore API

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.6.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 7.1 and later

Installation & Usage

Composer

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

{
  "require": {
    "bravecollective/neucore-api": "^1.6"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/vendor/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');



// Configure Bearer authorization: BearerAuth
$config = Brave\NeucoreApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Brave\NeucoreApi\Api\ApplicationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$request_body = array(56); // int[] | EVE alliance IDs array.

try {
    $result = $apiInstance->allianceGroupsBulkV1($request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApplicationApi->allianceGroupsBulkV1: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/api

Class Method HTTP request Description
ApplicationApi allianceGroupsBulkV1 POST /app/v1/alliance-groups Return groups of multiple alliances.
ApplicationApi allianceGroupsV1 GET /app/v1/alliance-groups/{aid} Return groups of the alliance.
ApplicationApi allianceGroupsV2 GET /app/v2/alliance-groups/{aid} Return groups of the alliance.
ApplicationApi charactersV1 GET /app/v1/characters/{characterId} Return all characters of the player account to which the character ID belongs.
ApplicationApi corpGroupsBulkV1 POST /app/v1/corp-groups Return groups of multiple corporations.
ApplicationApi corpGroupsV1 GET /app/v1/corp-groups/{cid} Return groups of the corporation.
ApplicationApi corpGroupsV2 GET /app/v2/corp-groups/{cid} Return groups of the corporation.
ApplicationApi corporationPlayersV1 GET /app/v1/corp-players/{corporationId} Return a list of all players that have a character in the corporation.
ApplicationApi esiPostV1 POST /app/v1/esi Makes an ESI POST request on behalf on an EVE character and returns the result.
ApplicationApi esiV1 GET /app/v1/esi Makes an ESI GET request on behalf on an EVE character and returns the result.
ApplicationApi groupsBulkV1 POST /app/v1/groups Return groups of multiple players, identified by one of their character IDs.
ApplicationApi groupsV1 GET /app/v1/groups/{cid} Return groups of the character's player account.
ApplicationApi groupsV2 GET /app/v2/groups/{cid} Return groups of the character's player account.
ApplicationApi groupsWithFallbackV1 GET /app/v1/groups-with-fallback Returns groups from the character's account, if available, or the corporation and alliance.
ApplicationApi mainV1 GET /app/v1/main/{cid} Return the main character of the player account to which the character ID belongs.
ApplicationApi mainV2 GET /app/v2/main/{cid} Return the main character of the player account to which the character ID belongs.
ApplicationApi memberTrackingV1 GET /app/v1/corporation/{id}/member-tracking Return corporation member tracking data.
ApplicationApi playerCharactersV1 GET /app/v1/player-chars/{playerId} Return all characters from the player account.
ApplicationApi playerV1 GET /app/v1/player/{characterId} Return the player account to which the character ID belongs.
ApplicationApi removedCharactersV1 GET /app/v1/removed-characters/{characterId} Return all characters that were removed from the player account to which the character ID belongs.
ApplicationApi showV1 GET /app/v1/show Show app information.

Documentation For Models

Documentation For Authorization

BearerAuth

  • Type: Bearer authentication

Author