Home

Yapeal

Yet Another Php Eve Api Library

Description

Used to get XML files from the EVE-Online API and store the results in a MySQL database.

More detailed description

Yapeal not only grabs the data from the API for you but also saves the data into a MySQL database as well. It was made to be ran from a crontab job or a scheduled task and works in the background to 'Auto-magically' as I call it, keep the database updated so all you have to do is work with the database tables not the API and XML. It was designed to have a set and forget configuration.

Requirements

Minmium PHP 5.3.2 is required by Composer to install but for the Yapeal 1.0.x series anything in the later part of PHP 5.2.x should run it. Current plans are to keep the requirements of Yapeal at no more than what is found in Ubuntu 10.04 (Lucid) or OpenSuSE 12.x but this is subject to change if a real need arises for a feature or bug fix that isn't back ported.

You should use Composer to install Yapeal now and it will take care of letting you know about any other requirements or missing dependencies.

Forward to the future

I've written one page so far to detail the expected changes that are happening with Yapeal during the build up to Yapeal 2 which you can find in [Moving Forward]

After downloading - 1.0.x

After you've decided to give Yapeal a try you should have a look at the featured pages to better understand how to use it and how it works. Also make sure to visit the Eve Technology Lab forum thread for more information that should be helpful in setting up and using Yapeal.

Featured Pages - 1.0.x

[KeyFiles] - List with short description of some key files in Yapeal.
[StarterGuide] - A Starter Guide for new and experienced web developers.
[utilTablesIntroduction] - Introduction to the util* tables of Yapeal.
[UnderstandingErrorLogs] - Here's a quick set of notes about error messages/logs.

Series - 1.0.x

There are several series of pages that should be of interest to anyone learning about or using Yapeal. They start at:

[StarterGuide] - A Starter Guide for new and experienced web developers.
[utilTablesIntroduction] - Introduction to the util* tables of Yapeal.
[HierarchicalData] - Varies ways of dealing with hierarchical data in a flat DB table.

Features - 1.0.x

• Auto download of API data
• Auto updating of database tables
• Uses cURL for API download to be hosted site friendly
• Uses ADOdb (included) for database updating
• Made to be ran from crontab or scheduled task (preferred setup)
• Runs from command-line for debugging or special needs
• Uses the database to keep track of API cachedUntil times so it is API friendly even when ran from crontab or scheduled task
• Does optional local caching of raw API's XML file to a directory and/or the database
• Works with multiple corporations and multiple characters by just adding their information to database tables

Public API key

Ok I've decided with the new custom API key system to see if I can get something started with the third party developers. I would like to see them post a open API key that just let's anyone using their software see themselves and the alts on the account. The idea is if we as developers are open about who we are and what we do in game than some people will be more comfortable using the applications and other software we all write or maintain. I have other developers look at Yapeal and would really like to use it but often the corporation/alliance worries about using outside software. This is just one of the reason I made Yapeal open source so anyone with a technical background can see there's no spybots etc in it. Posting an open API key with very limited access that wasn't possible before just seems like the next logical step now with the custom API keys.

ID	Name	Verification Code	Character	Type	Access Mask	Expires
1156	Public1	abc123	All	Character	8388608	-

Project Admins:

• Michael Cummings
• Michael Cummings