Embed Size (px)
DESCRIPTION
http://www.amee.com An introduction to the AMEE platform, and how to use it to embed environmental intelligence in your applications.
Citation preview
Web-based API for aggregation of energy &
activity data, withCarbon models
Act On CO2
Carbonetworks
Misys OpenCarbonWorld
“Powered By AMEE” means you are working with authoritative models
Applications
RESTful HTTP APIXML, JSON and Atom
ProfilesStore your energy data and history
DataIndustry standard models,applied to calculate carbon result
API Details
Data Profiles
AuthoritativeModels Your Data
CO2 Result
PUT
GET
Sign up for a free API key:http://my.amee.com/signup
Staging platformhttp://stage.amee.comFree access for development & testing
Live platformhttp://live.amee.comProduction platform
Getting Started
Release using live.amee.com
Develop using stage.amee.com
Sign Up
FREE
All API requests require authentication
HTTP BasicUsername/password sent with each request
Authentication SessionsOne-time loginGet back and authToken and send with subsequent requestsTokens expire after two hours, or half an hour of inactivity
Authentication
Store your data in AMEE profilesCreate as many profiles as you like, and choose what they represent
No personal data stored in AMEEProfiles are identified only by random UID string
Storing Data
POST /profilesAccept: application/xmlContent-Type: application/x-www-form-urlencodedSet-Cookie: authToken: <authtoken>profile=true
Category Hierarchy in each profileSimilar to a folder structure
Top LevelHome,Business,Transport,etc.
Profile ItemsContained within categoriesStore your data
Profile Categories
Fetching Profile Categories
POST /profiles/7C7D68C2A7CD/home/energy/quantity Accept: application/xmlContent-Type: application/x-www-form-urlencodedSet-Cookie: authToken: <authtoken>dataItemUid=66056991EE23&energyConsumption=1000
Creating Profile Items
HTTP/1.1 201 CREATEDLocation: https://stage.amee.com/profiles/7C7D68C2A...
ISO 8601 times/durations
startDate / endDate2009-08-13T09:22Z
durationP23DT23H
Item namesDistinguish separate series ofsame item in same category
Profile History
Series1 Series1 Series1
Series2 Series2
TIME
Category hierarchyas for profilescontains data items
Items store science datae.g. CO2 emission factors
Data items have unique UIDsbut...
The Data API
Drilldowns
Data Item UIDs CAN CHANGEThey change between platformsDo not hardcode UIDs in your app – it WILL break when you go live
Item names DO NOT CHANGEUse drilldown resource to convert item names into UIDs
GET /data/home/energy/quantity/drill?type=gasAccept: application/xmlSet-Cookie: authToken: <authtoken>
Data Documentation
AMEE Data Wiki: http://wiki.amee.com
Contains detailed documentation on all elements in AMEEIncluding calculations and sources
Helps you discover and choose which data to use
API Documentation (my.amee.com/developers)
Browser Interface
