Skip to content
This repository has been archived by the owner on Mar 9, 2020. It is now read-only.
Michael Cummings edited this page Jul 25, 2014 · 5 revisions

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. Yapeal now requires minimum PHP 5.4.

You should use Composer to install Yapeal now and it will take care of letting you know about any other requirements or missing dependencies. Make sure you look at the README.md, INSTALL.md, and CONFIG.md files.

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 NO LONGER SUPPORTED AFTER CRIUS

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 NO LONGER SUPPORTED AFTER CRIUS

Key Files - List with short description of some key files in Yapeal. Starter Guide - A Starter Guide for new and experienced web developers. util Tables Introduction - Introduction to the util* tables of Yapeal. Understanding Error Logs - Here's a quick set of notes about error messages/logs.

Series - 1.0.x NO LONGER SUPPORTED AFTER CRIUS

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

Starter Guide - A Starter Guide for new and experienced web developers. util Tables Introduction - Introduction to the util* tables of Yapeal. Hierarchical Data - Varies ways of dealing with hierarchical data in a flat DB table.

Features - 1.0.x NO LONGER SUPPORTED AFTER CRIUS

  • 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 -

Public GPG Key

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v2.0.22 (MingW32)

mQENBFOYm8UBCADhXBq0hg3sIJnlP1lrndelMPwGeSb47ldWgy7LCWJtXDf9dNnK
DXaxyGvg56grVS2M5myKJDYjIOjGQrxkOMuhWUAWPNHUwkHcAV1XddfeTwr/u6ER
RApb8vCIyry77UPAQUPoA5NGeA1J3Nxah2ft7NGJHKI0F7vqedc8ZiAj4nwKr++z
AiMGc3gdsdUxsPbxouS4w/RKp/f9j2bOBDP9pqLHYsqzRwpKSVhlbeBc09AeS2CV
Y/m/cSN4aD2zZF8dxPqEDCD6Xze0Mp+PTgsHkoJodfc3CG2zpzFNHFWKOg7HzlFX
Jkg9R9HEhKQLmYhikN05Ycji0TRIfM8VMAeBABEBAAG0J01pY2hhZWwgQ3VtbWlu
Z3MgPG1nY3VtbWluZ3NAeWFob28uY29tPokBOQQTAQIAIwUCU5ibxQIbAwcLCQgH
AwIBBhUIAgkKCwQWAgMBAh4BAheAAAoJEHxChHv8cGY9GXoIALJ9NnitVb8CB8lo
g7vLq/rQwbl3dZFAH2SX7aDbMROYqavEkd8GA3PWMPSUYIUbz4lzf5HqqCD3V70k
2uQN1xrLVCeMl7fPV2KRVkjErFkos4vA6BO4xYPQzpqB30XtTtfn0yUlp6IxApnx
N1T8nUktoLjShrqjYmN3KZ2VjxESsEuDl74tj1ZAX+UB6qUH0lQRWegckJR3OhqO
un+exrS3J7Oeu18aS6kn4SidPAsYWb2b6BWA6QAV1ad+1rrcN8VUrKI3/d9O2ipl
GKXVgdKkHBmgZH1l9xjuBv+shcPV5zzZ6srR96zI1F4RwGeBdnK/IU2vPYcTjLGf
6qY/xga5AQ0EU5ibxQEIANKj1FpTFAIlO6SE6/UGjSV1YEKFiiIPIp5W4qFhgSO8
uMlz8G1w7im5i43oIURVY7H/ccJb/ZlqZ+jhPUD/BfveDKeEK/PAuSMu8/WpneDw
NhzI5NHR5SCOFTBZJrYPhvFlONU+GjOG1/FyjP0/C8STPMpDgdAIXoA4mmJfn1YO
WHgZMEoDOTHCxbrGKHZSUu3kWFq+dCzjH/WPXi+EvqnLON8hFa1xx74c0tXkkJbM
bnG2c28wugVjqEB5PL2O/2MfCSotNgvzEKnc6h5uuRBOckSfRX4mdfMB7Q+hisPJ
C4wS92HHKq3BWiGKMCMNa2k8bDG9/5zHxxxhU2qnUyUAEQEAAYkBHwQYAQIACQUC
U5ibxQIbDAAKCRB8QoR7/HBmPeekB/4zc8mvIhRq8a0b6fw80CfFYUsvg+kupspg
RkB7LoDiIg3PM5+3ipXSRok7H0wnlMAsNADCKwi9GrpTcS2iS9b0H7+dlFd+tEGs
+krS3ZHJp6GgBREh1iZTb6fftVbJ7199Uexa9WlPqbaXkhG+SFQxdl98QicwfVEg
jxRB1ZCkh5JOyFA8T5qSPy5bWJVrcMHReJh83rHq3p+pT6PV2B8WPCbpLZbtWs4K
kjnA38W61h1/9FUfQOQ3nKBbXxZn9JZNs7toEVoaMPtLOmHgmckt4MfQ2rgOcpmz
YGnSeb+L5Dyjmb8WKG3YGTUJEbSnxOIWqBHMPTIczIyZVYc9NwfO
=Wm6+
-----END PGP PUBLIC KEY BLOCK-----