AMEE API

Table of Contents

  1. Introduction
  2. Overview
  3. API Manual
    1. API Reference
  4. External References

Introduction

This documentation describes the AMEE API. The API will change and naturally evolve over time as the data and requirements evolve. However key concepts, interactions and responses will remain essentially the same to that described herein.

This documentation assumes an understanding of the data structures and concepts of AMEE. An understanding of the relevant web technologies, concepts and techniques is also assumed (see learning resources below).

Overview

The AMEE API is exposed by and built-in to AMEE. AMEE also provides a standard web-based interface for end users and administrators. The AMEE API closely mirrors the structure of the web interface.

Some key points regarding the AMEE API:

  • The API is based on the REST architectural style.
  • All API operations are fulfilled via standard HTTP methods (GET, POST, PUT, DELETE).
  • Resources are represented with HTML, XML or JSON.

API Manual

API Reference

External References