Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This wiki contains the documentation for the MILK Books API.

Both the API and the documentation are works-in-progress. This documentation describes the funcionality as it stands, as well as planned functionality for the future.

Overview

This documentation is aimed at a developer who wishes to interface with the MILK Books API and assumes familiarity with the following technologies

  • HTTP (Verbs, Custom Headers)
  • REST

Flow

The normal flow a user would take through an order is as follows:

  1. If not registered, create a User
  2. If no existing session, create a Session
  3. Create a Project (Planned)
  4. Create a Basket (Planned)
  5. Add a Project to a Basket (Planned)
  6. Show Basket Contents (Planned)
  7. Checkout (Planned)
  8. Order Status (Planned)