Difference between revisions of "API"
From TimeMD Help
(→Overview) |
|||
| Line 4: | Line 4: | ||
* Even though each TimeMD account has a unique "Access URL" (or "Client URL"). You'll use our dedicated API URL for all calls to the server. In this case the URL is ‘login.timemd.com’. | * Even though each TimeMD account has a unique "Access URL" (or "Client URL"). You'll use our dedicated API URL for all calls to the server. In this case the URL is ‘login.timemd.com’. | ||
=== What You Should Know First === | === What You Should Know First === | ||
| − | * TimeMD.com uses a REST interface for our API. [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] is a simple format that allows you to make queries by constructing a URI containing variables and values and submitting to our API web page. The server responds with XML or JSON output containing the information that you requested. | + | * TimeMD.com uses a REST interface for our API. [http://en.wikipedia.org/wiki/Representational_State_Transfer REST] is a simple format that allows you to make queries by constructing a URI containing variables and values and submitting to our API web page. The server responds with [http://en.wikipedia.org/wiki/XML XML] or [http://en.wikipedia.org/wiki/JSON JSON] output containing the information that you requested. |
* Each API request is composed of two parts. An action and variables for that action. Additionally, all API calls (with the exception of register_device) require an api_key parameter that proves you are logged in. Normally you won't have to worry about this though, since our PHP class handles authentication for you. | * Each API request is composed of two parts. An action and variables for that action. Additionally, all API calls (with the exception of register_device) require an api_key parameter that proves you are logged in. Normally you won't have to worry about this though, since our PHP class handles authentication for you. | ||
Revision as of 16:28, 10 February 2012
Overview
Getting Started
- First you'll need to authenticate the device you are using.
- Even though each TimeMD account has a unique "Access URL" (or "Client URL"). You'll use our dedicated API URL for all calls to the server. In this case the URL is ‘login.timemd.com’.
What You Should Know First
- TimeMD.com uses a REST interface for our API. REST is a simple format that allows you to make queries by constructing a URI containing variables and values and submitting to our API web page. The server responds with XML or JSON output containing the information that you requested.
- Each API request is composed of two parts. An action and variables for that action. Additionally, all API calls (with the exception of register_device) require an api_key parameter that proves you are logged in. Normally you won't have to worry about this though, since our PHP class handles authentication for you.
