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):
- List the available Products
- If not registered, create a User
- If no existing session, create a Session
- Create a Project
- Create a Basket
- Add a Project to a Basket (creating a Basket Line)
- Project Artifacts are uploaded (or deferred)
- Checkout (Planned)
- Order Status (Planned)