mglinski/php-esi-lib

An autogenerated ESI Library with docs and tests.

v0.3.9.0 2017-01-25 12:19 UTC

This package is auto-updated.

Last update: 2021-11-14 12:48:02 UTC


README

An OpenAPI for EVE Online

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

  • API version: 0.3.9
  • Build date: 2017-01-25T12:12:13.556-05:00
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, run composer require mglinski/php-esi-lib

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
use ESI\Client\ApiException;
use ESI\Client\HTTPlugApiClient;

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

$api_instance = new ESI\Client\Api\AllianceApi(new HTTPlugApiClient());

$datasource = "tranquility"; // string | The server name you would like data from

try {
    $result = $api_instance->getAlliances($datasource);
    var_dump($result);
} catch (ApiException $e) {
    echo 'Exception when calling AllianceApi->getAlliances: ', $e->getResponseHeaders()[0], ' "', $e->getResponseBody()->error, '"', PHP_EOL;
}

Documentation for API Endpoints

All URIs are relative to https://esi.tech.ccp.is/latest

ClassMethodHTTP requestDescription
AllianceApigetAlliancesGET /alliances/List all alliances
AllianceApigetAlliancesAllianceIdGET /alliances/{alliance_id}/Get alliance information
AllianceApigetAlliancesAllianceIdCorporationsGET /alliances/{alliance_id}/corporations/List alliance's corporations
AllianceApigetAlliancesAllianceIdIconsGET /alliances/{alliance_id}/icons/Get alliance icon
AllianceApigetAlliancesNamesGET /alliances/names/Get alliance names
AssetsApigetCharactersCharacterIdAssetsGET /characters/{character_id}/assets/Get character assets
BookmarksApigetCharactersCharacterIdBookmarksGET /characters/{character_id}/bookmarks/List bookmarks
BookmarksApigetCharactersCharacterIdBookmarksFoldersGET /characters/{character_id}/bookmarks/folders/List bookmark folders
CalendarApigetCharactersCharacterIdCalendarGET /characters/{character_id}/calendar/List calendar event summaries
CalendarApigetCharactersCharacterIdCalendarEventIdGET /characters/{character_id}/calendar/{event_id}/Get an event
CalendarApiputCharactersCharacterIdCalendarEventIdPUT /characters/{character_id}/calendar/{event_id}/Respond to an event
CharacterApigetCharactersCharacterIdGET /characters/{character_id}/Get character's public information
CharacterApigetCharactersCharacterIdCorporationhistoryGET /characters/{character_id}/corporationhistory/Get corporation history
CharacterApigetCharactersCharacterIdPortraitGET /characters/{character_id}/portrait/Get character portraits
CharacterApigetCharactersNamesGET /characters/names/Get character names
CharacterApipostCharactersCharacterIdCspaPOST /characters/{character_id}/cspa/Calculate a CSPA charge cost
ClonesApigetCharactersCharacterIdClonesGET /characters/{character_id}/clones/Get clones
CorporationApigetCorporationsCorporationIdGET /corporations/{corporation_id}/Get corporation information
CorporationApigetCorporationsCorporationIdAlliancehistoryGET /corporations/{corporation_id}/alliancehistory/Get alliance history
CorporationApigetCorporationsCorporationIdIconsGET /corporations/{corporation_id}/icons/Get corporation icon
CorporationApigetCorporationsCorporationIdMembersGET /corporations/{corporation_id}/members/Get corporation members
CorporationApigetCorporationsCorporationIdRolesGET /corporations/{corporation_id}/roles/Get corporation member roles
CorporationApigetCorporationsNamesGET /corporations/names/Get corporation names
FleetsApideleteFleetsFleetIdMembersMemberIdDELETE /fleets/{fleet_id}/members/{member_id}/Kick fleet member
FleetsApideleteFleetsFleetIdSquadsSquadIdDELETE /fleets/{fleet_id}/squads/{squad_id}/Delete fleet squad
FleetsApideleteFleetsFleetIdWingsWingIdDELETE /fleets/{fleet_id}/wings/{wing_id}/Delete fleet wing
FleetsApigetFleetsFleetIdGET /fleets/{fleet_id}/Get fleet information
FleetsApigetFleetsFleetIdMembersGET /fleets/{fleet_id}/members/Get fleet members
FleetsApigetFleetsFleetIdWingsGET /fleets/{fleet_id}/wings/Get fleet wings
FleetsApipostFleetsFleetIdMembersPOST /fleets/{fleet_id}/members/Create fleet invitation
FleetsApipostFleetsFleetIdWingsPOST /fleets/{fleet_id}/wings/Create fleet wing
FleetsApipostFleetsFleetIdWingsWingIdSquadsPOST /fleets/{fleet_id}/wings/{wing_id}/squads/Create fleet squad
FleetsApiputFleetsFleetIdPUT /fleets/{fleet_id}/Update fleet
FleetsApiputFleetsFleetIdMembersMemberIdPUT /fleets/{fleet_id}/members/{member_id}/Move fleet member
FleetsApiputFleetsFleetIdSquadsSquadIdPUT /fleets/{fleet_id}/squads/{squad_id}/Rename fleet squad
FleetsApiputFleetsFleetIdWingsWingIdPUT /fleets/{fleet_id}/wings/{wing_id}/Rename fleet wing
IncursionsApigetIncursionsGET /incursions/List incursions
IndustryApigetIndustryFacilitiesGET /industry/facilities/List industry facilities
IndustryApigetIndustrySystemsGET /industry/systems/List solar system cost indices
InsuranceApigetInsurancePricesGET /insurance/prices/List insurance levels
KillmailsApigetCharactersCharacterIdKillmailsRecentGET /characters/{character_id}/killmails/recent/List kills and losses
KillmailsApigetKillmailsKillmailIdKillmailHashGET /killmails/{killmail_id}/{killmail_hash}/Get a single killmail
LocationApigetCharactersCharacterIdLocationGET /characters/{character_id}/location/Get character location
LocationApigetCharactersCharacterIdShipGET /characters/{character_id}/ship/Get current ship
MailApideleteCharactersCharacterIdMailMailIdDELETE /characters/{character_id}/mail/{mail_id}/Delete a mail
MailApigetCharactersCharacterIdMailGET /characters/{character_id}/mail/Return mail headers
MailApigetCharactersCharacterIdMailLabelsGET /characters/{character_id}/mail/labels/Get mail labels and unread counts
MailApigetCharactersCharacterIdMailListsGET /characters/{character_id}/mail/lists/Return mailing list subscriptions
MailApigetCharactersCharacterIdMailMailIdGET /characters/{character_id}/mail/{mail_id}/Return a mail
MailApipostCharactersCharacterIdMailPOST /characters/{character_id}/mail/Send a new mail
MailApipostCharactersCharacterIdMailLabelsPOST /characters/{character_id}/mail/labels/Create a mail label
MailApiputCharactersCharacterIdMailMailIdPUT /characters/{character_id}/mail/{mail_id}/Update metadata about a mail
MarketApigetMarketsPricesGET /markets/prices/List market prices
MarketApigetMarketsRegionIdHistoryGET /markets/{region_id}/history/List historical market statistics in a region
MarketApigetMarketsRegionIdOrdersGET /markets/{region_id}/orders/List orders in a region
PlanetaryInteractionApigetCharactersCharacterIdPlanetsGET /characters/{character_id}/planets/Get colonies
PlanetaryInteractionApigetCharactersCharacterIdPlanetsPlanetIdGET /characters/{character_id}/planets/{planet_id}/Get colony layout
PlanetaryInteractionApigetUniverseSchematicsSchematicIdGET /universe/schematics/{schematic_id}/Get schematic information
SearchApigetCharactersCharacterIdSearchGET /characters/{character_id}/search/Search on a string
SearchApigetSearchGET /search/Search on a string
SkillsApigetCharactersCharacterIdSkillqueueGET /characters/{character_id}/skillqueue/Get character's skill queue
SkillsApigetCharactersCharacterIdSkillsGET /characters/{character_id}/skills/Get character skills
SovereigntyApigetSovereigntyCampaignsGET /sovereignty/campaigns/List sovereignty campaigns
SovereigntyApigetSovereigntyStructuresGET /sovereignty/structures/List sovereignty structures
UniverseApigetUniverseStationsStationIdGET /universe/stations/{station_id}/Get station information
UniverseApigetUniverseStructuresGET /universe/structures/List all public structures
UniverseApigetUniverseStructuresStructureIdGET /universe/structures/{structure_id}/Get structure information
UniverseApigetUniverseSystemsSystemIdGET /universe/systems/{system_id}/Get solar system information
UniverseApigetUniverseTypesTypeIdGET /universe/types/{type_id}/Get type information
UniverseApipostUniverseNamesPOST /universe/names/Get names and categories for a set of ID's
WalletApigetCharactersCharacterIdWalletsGET /characters/{character_id}/wallets/List wallets and balances
WarsApigetWarsGET /wars/List wars
WarsApigetWarsWarIdGET /wars/{war_id}/Get war information
WarsApigetWarsWarIdKillmailsGET /wars/{war_id}/killmails/List kills for a war

Documentation For Models

Documentation For Authorization

evesso

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://login.eveonline.com/oauth/authorize
  • Scopes:
  • esi-assets.read_assets.v1: EVE SSO scope esi-assets.read_assets.v1
  • esi-bookmarks.read_character_bookmarks.v1: EVE SSO scope esi-bookmarks.read_character_bookmarks.v1
  • esi-calendar.read_calendar_events.v1: EVE SSO scope esi-calendar.read_calendar_events.v1
  • esi-calendar.respond_calendar_events.v1: EVE SSO scope esi-calendar.respond_calendar_events.v1
  • esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1
  • esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1
  • esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1
  • esi-fleets.read_fleet.v1: EVE SSO scope esi-fleets.read_fleet.v1
  • esi-fleets.write_fleet.v1: EVE SSO scope esi-fleets.write_fleet.v1
  • esi-killmails.read_killmails.v1: EVE SSO scope esi-killmails.read_killmails.v1
  • esi-location.read_location.v1: EVE SSO scope esi-location.read_location.v1
  • esi-location.read_ship_type.v1: EVE SSO scope esi-location.read_ship_type.v1
  • esi-mail.organize_mail.v1: EVE SSO scope esi-mail.organize_mail.v1
  • esi-mail.read_mail.v1: EVE SSO scope esi-mail.read_mail.v1
  • esi-mail.send_mail.v1: EVE SSO scope esi-mail.send_mail.v1
  • esi-planets.manage_planets.v1: EVE SSO scope esi-planets.manage_planets.v1
  • esi-search.search_structures.v1: EVE SSO scope esi-search.search_structures.v1
  • esi-skills.read_skillqueue.v1: EVE SSO scope esi-skills.read_skillqueue.v1
  • esi-skills.read_skills.v1: EVE SSO scope esi-skills.read_skills.v1
  • esi-universe.read_structures.v1: EVE SSO scope esi-universe.read_structures.v1
  • esi-wallet.read_character_wallet.v1: EVE SSO scope esi-wallet.read_character_wallet.v1

Author