Home

This wiki contains the documentation for the MILK Books API.

Both the API and the documentation are works-in-progress. This documentation describes the functionality 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, Status Codes)
• REST
• JSON Web Tokens (JWT) and JSON Web Signatures (JWS)

For more details on technology, see Technology and Environments.

Flow

The normal flow a user would take through an order is as follows (also see Examples):

1. List the available Products
2. If not registered, create a User
3. If no existing session, create a Session
4. Create a Project
5. Create a Basket
6. Add a Project to a Basket (creating a Basket Line)
7. Project Artifacts are uploaded (or deferred)
8. Checkout
9. Get Order details
10. View order status in the Customer Portal