Totsy-API

Created: 2012-03-22 21:08
Updated: 2014-02-11 01:54
php

README.md

Totsy REST API Server

The Totsy REST API server implementation is a PHP web application built atop the open-source REST web service framework Sonno and the Magento e-commerce platform.

The application expects two environment variables set (typically provided in the web server configuration):

  1. API_ENV is the application environment: dev | stg | prod

  2. MAGENTO_ROOT is the base path to the Magento web application root.

Dependencies

The project uses PHP Composer for dependency management. Specific dependencies can be found in the package.json file.

However, the only other dependency of the project, outside the scope of composer, is a Magento installation. The path to a local Magento installation must be supplied in a $MAGENTO_ROOT environment variable.

Documentation

All documentation is located in the doc directory.

Reference documentation (usage instructions) are located at doc/ref/.

The official Web Application Description Language (WADL) specification document is located at doc/wadl/totsy.wadl. A human-readable version of this document can be generated from this WADL file using the doc/wadl/totsy_wadl_doc-2006-10.xsl XSL stylesheet.

To-Do (Future)

  • Add a suite of integration tests using Guzzle and unit tests using the EcomDev_PHPUnit module.
  • Add analytics.
Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more