NAME

Games::EveOnline::API - A simple Perl wrapper around the EveOnline XML API. (DEPRECATED)

SYNOPSIS

use Games::EveOnline::API;
my $eapi = Games::EveOnline::API->new();

my $skill_groups = $eapi->skill_tree();
my $ref_types    = $eapi->ref_types();
my $systems      = $eapi->sovereignty();

# The rest of the methods require authentication.
my $eapi = Games::EveOnline::API->new( user_id => '..', api_key => '..' );

my $characters  = $eapi->characters();
my $sheet       = $eapi->character_sheet( character_id => $character_id );
my $in_training = $eapi->skill_in_training( character_id => $character_id );

DEPRECATED

This module is no longer being maintained as the XML API is no more.

DESCRIPTION

This module provides a Perl wrapper around the Eve-Online API, version 2. The need for the wrapper arrises for two reasons. First, the XML that is provided by the API is overly complex, at least for my taste. So, other than just returning you a perl data representation of the XML, it also simplifies the results.

Only a couple of the methods provided by this module can be used straight away. The rest require that you get a user_id (keyID) and api_key (vCode).

A NOTE ON CACHING

Most of these methods return a 'cached_until' value. I've no clue if this is CCP telling you how long you should cache the information before you should request it again, or if this is the point at which CCP will refresh their cache of this information.

Either way, it is good etiquet to follow the cacheing guidelines of a provider. If you over-use the API I'm sure you'll eventually get blocked.

ARGUMENTS

user_id

An Eve Online API user ID (also known as a keyID).

api_key

The key, as provided Eve Online, to access the API (also known as a vCode).

character_id

Set the default character_id. Any methods that require a characte ID, and are not given one, will use this one.

api_url

The URL that will be used to access the Eve Online API. Defaults to https://api.eveonline.com. Normally you won't want to change this.

ua

The underlying LWP::UserAgent object. Default to a new one with no special arguments. Override this if you want to, for example, enable keepalive or an HTTP proxy.

ANONYMOUS METHODS

These methods may be called anonymously, without authentication.

skill_tree

my $skill_groups = $eapi->skill_tree();

Returns a complex data structure containing the entire skill tree. The data structure is:

{
    cached_until => $date_time,
    $group_id    => {
        name   => $group_name,
        skills => {
            $skill_id => {
                name                => $skill_name,
                description         => $skill_description,
                rank                => $skill_rank,
                primary_attribute   => $skill_primary_attribute,
                secondary_attribute => $skill_secondary_attribute,
                bonuses             => {
                    $bonus_name => $bonus_value,
                },
                required_skills => {
                    $skill_id => $skill_level,
                },
            }
        }
    }
}

ref_types

my $ref_types = $eapi->ref_types();

Returns a simple hash structure containing definitions of the various financial transaction types. This is useful when pulling wallet information. The key of the hash is the ref type's ID, and the value of the title of the ref type.

sovereignty

my $systems = $eapi->sovereignty();

Returns a hashref where each key is the system ID, and the value is a hashref with the keys:

name
faction_id
sovereignty_level
constellation_sovereignty
alliance_id

RESTRICTED METHODS

These methods require authentication to use, so you must have set the "user_id" and "api_key" arguments to use them.

characters

my $characters = $eapi->characters();

Returns a hashref where key is the character ID and the value is a hashref with a couple bits about the character. Here's a sample:

{
    '1972081734' => {
        'corporation_name' => 'Bellator Apparatus',
        'corporation_id'   => '1044143901',
        'name'             => 'Ardent Dawn'
    }
}

character_sheet

my $sheet = $eapi->character_sheet( character_id => $character_id );

For the given character ID a hashref is returned with the all the information about the character. Here's a sample:

{
    'name'             => 'Ardent Dawn',
    'balance'          => '99010910.10',
    'race'             => 'Amarr',
    'blood_line'       => 'Amarr',
    'corporation_name' => 'Bellator Apparatus',
    'corporation_id'   => '1044143901',

    'skills' => {
        '3455' => {
            'level'        => '2',
            'skill_points' => '1415'
        },

        # Removed the rest of the skills for readability.
    },

    'attribute_enhancers' => {
        'memory' => {
            'value' => '3',
            'name'  => 'Memory Augmentation - Basic'
        },

        # Removed the rest of the enhancers for readability.
    },

    'attributes' => {
        'memory'       => '7',
        'intelligence' => '7',
        'perception'   => '4',
        'charisma'     => '4',
        'willpower'    => '17'
    }
}