FabulousCash Cron Site

Revision

This documentation was revised on January 2 2014 and matches version number 0.1.0.

Readme: Implementation and Use

This system is designed to (1) run commands on a scheduled basis for the API, and (2) represent testing for deployment of API sites. When setting up and installing this system, note how long it takes to establish in order to gauge other deployables.

Installation and Configuration

This application relies on numerous dependencies found within the composer packaging software. A current list of packages being used by this application can be found within the composer.json file.

If composer is not installed, run the following (L)UNIX command:

curl -sS https://getcomposer.org/installer | php

To install the application for the first time, run:

php composer.phar install

Before each upgrade, be sure to run:

php composer.phar update

The FabulousCash API requires, by default, authentication by a site in order to establish communication. It is likely that this website is not the first to have been created in order to interact with the FabulousCash API. If an administrative panel has already been created to interact with the API, that system should be used to add this site as a valid site. If not, interacting with the API to create a new site can be done with cURL:

curl -X POST -H "Content-Type: application/json" -k -d '{"domain":"example.com", "email":"postmaster@example.com"}' https://localhost/api/site

Configuration

Each configuration file is packaged as a template file. Simply reset the file extensions of these files from *.template to *.ini to configure.

The following configuration files need to be modified:

api.ini

• ID: This value is returned by the API during site creation.
• address: Set this to the public API address.
• pass_key: This value is returned by the API during site creation.
• ssl: The location of the ssl certs in order to establish API connection.

session.ini

• whitelist: Routes that bypass basic authentication.

theme.ini

• name: The current theme directory.

xCrypt.ini

• key: This value is returned by the API during site creation.

Communication and Authentication

Communication between the API and any site requires that the authentication, as explained in the above section, be correctly configured. Authentication can be disabled, like SSL, but it is highly recommended that both authentication and SSL be enabled and properly configured to safeguard interaction with the API and to ensure data integrity.

In order to properly configure SSL for use with PHP cURL, please reference Steve from Debian's article, Peter Chng's article, and David Walsh's article.

Routes / Sitemap

The following routes have been established as of December 2 2013:

• GET / Displays the readme.
• GET /run Runs all appropriate scheduled tasks.

Variable Interpretation

Because all information sent to and from the application is encoded or decoded as JSON objects, there's a high probability that information that is numerically assigned to zero, is set as null, is empty, or set as the equivalent to boolean false, will be treated similarly as unset. If that information must remain intact, the following replacement variables can be used instead:

0x0

The use of 0x0 as a string constitutes numerical zero.

Single Space

The use of a single space represents an empty string.