Difference between revisions of "REST API"

From the Directed Edge Developer Base
Jump to: navigation, search
(HTTP and HTTPS)
Line 10: Line 10:
  
 
== HTTP and HTTPS ==
 
== HTTP and HTTPS ==
 +
 +
The Directed Edge API allows for both HTTP and secured HTTPS connections.  HTTPS tends to incur a slightly higher latency since setting up the connection is more involved.
  
 
== API Authentication ==
 
== API Authentication ==

Revision as of 02:47, 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. Resources are just normal URLs organized hierarchically. In our case there is the database, items and things you can do with items (query, update, etc.).

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 resources and the methods allowed on them in the following sections.

HTTP and HTTPS

The Directed Edge API allows for both HTTP and secured HTTPS connections. HTTPS tends to incur a slightly higher latency since setting up the connection is more involved.

API Authentication

Database resource

HTTP GET

HTTP PUT

Item resource

HTTP GET

HTTP PUT

HTTP DELETE

Add and remove sub-resources

HTTP PUT

Related / recommended resources

HTTP GET

Query Parameters