Difference between revisions of "REST API"
From the Directed Edge Developer Base
(start new api documentation) |
(basic structure) |
||
| Line 1: | Line 1: | ||
| − | The | + | The Directed Edge [[Wikipedia:REST|REST]] API is a fairly simple way of modeling a collection of items and the relationships between them. These relationships are used as the basis for finding similar items or delivering personalized recommendations to a user. Information is encoded using our [[XML Format]] using notions from the [[API Concepts]]. |
| − | + | REST APIs allow for using the [[Wikipedia:Hypertext Transfer Protocol#Request_methods|HTTP methods]] GET, PUT, POST and DELETE on various resources. We'll explain below which of these are allowed. | |
| − | + | Let's have a look at an example URL: | |
| − | + | <nowiki>https://username:password@webservices.directededge.com/api/v1/wikipedia/</nowiki> | |
| − | + | This is the URL for the wikipedia database. Many of the elements are constant — notably the host name, and the ''api/v1'' sections. We'll break down the other components in the following sections. | |
| − | + | == HTTP and HTTPS == | |
| − | == | + | == API Authentication == |
| + | |||
| + | == Database resource == | ||
| + | |||
| + | === HTTP GET === | ||
| + | |||
| + | === HTTP PUT === | ||
| − | == | + | == Item resource == |
| + | |||
| + | === HTTP GET === | ||
| − | === HTTP | + | === HTTP PUT === |
| − | == | + | === HTTP DELETE === |
| − | == | + | === Add and remove sub-resources === |
| − | === | + | ==== HTTP PUT ==== |
| − | == | + | == Related / recommended resources == |
| − | === | + | === HTTP GET === |
| − | === | + | === Query Parameters === |
Revision as of 02:34, 23 May 2009
The Directed Edge REST API is a fairly simple way of modeling a collection of items and the relationships between them. These relationships are used as the basis for finding similar items or delivering personalized recommendations to a user. Information is encoded using our XML Format using notions from the API Concepts.
REST APIs allow for using the HTTP methods GET, PUT, POST and DELETE on various resources. We'll explain below which of these are allowed.
Let's have a look at an example URL:
https://username:password@webservices.directededge.com/api/v1/wikipedia/
This is the URL for the wikipedia database. Many of the elements are constant — notably the host name, and the api/v1 sections. We'll break down the other components in the following sections.
