Difference between revisions of "Main Page"

Revision as of 09:40, 11 August 2011

Introduction

The The Rackspace Email Rest API provides most of the functions of the Control Panel through a REST-based web API. Whether it is adding a new customer account, adding mailboxes, or any other of the supported features the API allows your application to administer the changes regardless of your application's language or nature. For more information on RESTful web services refer to the following sites:

Paul James's Homepage: A RESTful Web service, an example

Wikipedia: Representational State Transfer - External Links

The API is accessible to all with access to Control Panel, including resellers, business customers, enterprise customers, and indirect customers. However, not all operations are available to non-resellers. See the Operations section for more details.

The Rackspace Email Soap API Homepage has been moved to here.

Recent Changes

10/31/10

New features:

Rackspace Mailbox indexes now support custom fields.
A Login Token may now be generated for Rackspace Mailboxes.
Users can set Rackspace Mailbox storage notification settings. See here for more details.
Users can now manage admins. See here for more details.
Added Email Everyone to Domain operations. See here for more details.
Added Show/Edit Catch-All Address to Domain operations. See here for more details.

09/01/10

New features:

Now Rackspace Email Mailbox can be marked as visible in Exchange Global Address List.
Exchange Mailbox can be marked as visible in Rackspace Email Company Directory.
Rackspace Email/Exchange Mailbox last login time.
Filter Rackspace Email/Exchange Mailbox by "Enabled" flag.
Resellers now can create Login Token that only can be used to log into sub-account Control Panel. See here.

08/01/10

New features:

Added Rackspace Email Mailbox Contact info. See here.
Added Create Login Token. See here.

06/20/10

New features:

Added Rackspace Email Alias.

06/11/10

New features:

Added Rackspace Email Mailbox Spam Settings/Blacklist/Safelist. See here.
Now Rackspace Email Mailbox can Show/Edit vacation message and email forwarding address. See here.
Added SharePoint Service Settings. See here.

05/16/10

New features:

Added shortened URLs. Any URLs that starts with '/customers/me/domains/~' is equivalent to '/domains/~'.
Added Rackspace Email Mailbox Add/Edit/Delete/Index. See here.
Allows to customize Exchange mailbox list result. See Exchange Mailbox Index action 'Custom Fields' section.

Changes:

Server throttling section has been updated. See here.

Bug fix:

Fixed a bug that request without User-Agent Header gets 500 error. Now it gets "Authentication failed".

03/28/10

New features:

Rest API can be accessed by Business Users. However, not all operations are available.
Domain Public Folders can be enabled now.

Deprecated:

Good Mobile Service is no longer supported.

03/14/10

New features:

Index/Add/Edit/Delete Mailbox Permissions.

Known Issues:

Domain public folders can't be enabled using Rest API at this moment. The next release (on 03/21/2010) will fix this problem.

Operations

The following pages detail the operations that the API supports. The operations are grouped into sections based on the entity/object types that each operation interacts with. Non-resellers do not have access to all functions.

Resource	Example URI	Business User Access
Customer	/customers/123456789	Create Login Tokens
Admin	/customers/123456789/admins/my_admin	All
Domain	/customers/123456789/domains/example.com	Index, Show, Split Domain Routing, Archiving SSO Login URL, Domain Public Folders, Email Everyone , Catch-All Address
Domain Spam Settings	/customers/123456789/domains/example.com/spam/settings	All
Rackspace Email Mailbox	/customers/123456789/domains/example.com/rs/mailboxes/john.smith	All
Rackspace Email Mailbox Spam Settings	/customers/123456789/domains/example.com/rs/mailboxes/john.smith/spam	All
Rackspace Storage Notification Settings	/customers/123456789/domains/example.com/rs/storageNotification	All
Rackspace Email Alias	/customers/123456789/domains/example.com/rs/mailboxes/john.smith/alias	All
Exchange Mailbox	/customers/123456789/domains/example.com/ex/mailboxes/john.smith	All
Exchange Mailbox Spam Settings	/customers/123456789/domains/example.com/ex/mailboxes/john.smith/spam	All
Exchange Contact	/customers/123456789/domains/example.com/ex/contacts/john.smith	All
Exchange Distribution List	/customers/123456789/domains/example.com/ex/distributionlists/group.name	All
Exchange Resource Mailbox	/customers/123456789/domains/example.com/ex/resources/conference.room	All
SharePoint	/customers/123456789/sharepoint/settings	Show

The examples shown in the operation pages are written in Ruby and extensively use the helper functions shown in the Ruby Examples below.

Quick Start

What you need:

A Rackspace Email and Apps Control Panel admin account
A HTTP class library that supports TLS and the HTTP methods: GET, POST, PUT, DELETE.

Making your first API call, an Show Customer request:

Obtain your API keys
- Click on My Account at the top of the Control Panel web interface. Under the Administrators heading there will be an link for the API keys page.
Set up your client's HTTP request
- Set up your client to make calls to a URL beginning with https://api.emailsrvr.com/v0.
- Populate the Accept, User-Agent and X-Api-Signature HTTP request headers correctly. This is explained in detail here.
Make a GET request to /customers/me.
- The complete URI will be https://api.emailsrvr.com/v0/customers/me. Use your HTTP library to retrieve the HTTP response code, 'x-error-message' HTTP response header and HTTP response body so that they may be displayed to help debug and determine success.

From here:

Learn about the operations you'll be implementing at the subpages here.

Accessing the API

Your application will need to make HTTP requests to remote servers. Most programming languages have this function provided in its class library. In addition to the common GET and POST HTTP methods, the library used will also need to support PUT and DELETE.

Calls without TLS (formerly SSL) will complete successfully but it is HIGHLY RECOMMENDED that TLS always be used. Interception of unencrypted communication will allow a third party to have complete access to all functions available via the API.

For some language libraries just using an URL with https:// will cause the library to use TLS. In some other libraries however some options specific to the library may have to be configured to utilize TLS.

All API calls should be directed to a URL in the following format:

https://api.emailsrvr.com/(version)/(resource)

Example:

https://api.emailsrvr.com/v0/customers/12345678/domains/customerbusiness.com

Versions

Supported Versions	URL	Version Documentation
v0 (current)	https://api.emailsrvr.com/v0/	http://signup.apps.rackspace.com/api-wiki/index.php/Rest_API

The API version number is a component of the URL that is used to access the API. For example, to access the root of the API, the URL is https://api.emailsrvr.com/v0/. Bug fixes and minor non-breaking changes will be made without changing the version number. When major features or breaking changes are introduced, the version number will be incremented. It is not yet determined how many versions are going to be supported at any one time.

Non-breaking Changes	Breaking Changes
Adding new fields or attributes to form fields sent	Changing or deleting any fields in form fields sent
Adding fields in returned data	Changing or removing fields in returned data
	Changing the URI of any resource

Authentication

To gain access to the API, your request must include a properly constructed X-Api-Signature HTTP header. Details on what to put in the header are below. To construct the header, you must have the following keys that that are generated from the Control Panel Web interface. The key generation page can be found by clicking 'My Account' at the top, then 'Generate API Keys' in the Administrators section.

Key Name	Description	Example
User Key	A public key that corresponds to your admin id	eGbq9/2hcZsRlr1JV1Pi
Secret Key	A shared secret key	QHOvchm/40czXhJ1OxfxK7jDHr3t

An unsuccessful authentication will result in a 403 HTTP code.

X-Api-Signature Header

Format is as follows: <User Key>:<Timestamp>:<SHA1 Hash>
Example: eGbq9/2hcZsRlr1JV1Pi:20010317143725:46VIwd66mOFGG8IkbgnLlXnfnkU=

Remember to include the colons between the data strings!

User Key:
This is the public key issued by the Control Panel browser interface.

Timestamp:
The format is YYYYMMDDHHmmss. All values besides year are zero-padded to two spaces. For example, March 08th 2001 at 2:37.25pm would be 20010308143725.

YYYY	Four-digit year
MM	Month
DD	Day
HH	Hour in 24h format
mm	Minute
ss	Second

SHA1 Hash:

A SHA1 (Secure Hash Algorithm) hash must be applied to a string with the following information:

<User Key><User Agent><Timestamp><Secret Key>

Note that the 'User Agent' must be the exact same as what is specified in the User-Agent HTTP header. Using the above example data, the string before hashing is:
eGbq9/2hcZsRlr1JV1PiRackspace Management Interface20010308143725QHOvchm/40czXhJ1OxfxK7jDHr3t

Resulting base-64 SHA1 Hash:
46VIwd66mOFGG8IkbgnLlXnfnkU=

Be sure to encode the binary hash, not the hex hash, into base-64. The resulting string should be 28 characters long.

Using the API

Requests

HTTP requests should be sent to the server with the correct URL, HTTP method, HTTP headers and form data (if needed). The URL specifies the resource, the HTTP method specifies what operation is done on the resource, and form data is used to specify the details of the resource when the resource is added or edited.

The URLs, corresponding HTTP methods, and necessary form data for the desired operations are detailed in the operation pages.

If you're getting the HTTP status code 417 see Handling HTTP code 417: Expectation failed

URL

The URLs are specifies the resource or resource collection. Objects are organized in a tree collection, starting with customers at the top, then domains, then domain objects next (such as mailboxes, contacts, and distribution lists) and so on. The URLs of the resources and collections accessible are found on the operation pages.

HTTP Method

It is the HTTP method that specifies what operation will be done on the resource. For example, to get the details of a mailbox a HTTP GET will be done on /customers/12345678/domains/example.com/ex/mailboxes/john.smith. If the mailbox does not exist, a HTTP POST to the same URL with the necessary form data will add the mailbox. Then, a HTTP PUT to the same URL will edit mailbox. And to delete the mailbox, an HTTP DELETE would be used.

The types of operations a certain method performs is outlined below.

HTTP Method	Operations	Response
GET	Index - returns a list of the resources	XML or JSON formatted data
GET	Show - returns the details of the resource	XML or JSON formatted data
POST	Add - adds a new resource	Response code and error message (if applicable) only
PUT	Edit - changes the details of the resource
DELETE	Delete - deletes the resource

HTTP Headers

All requests to the API must then include HTTP headers with the following information:

Header Name	Description	Example Header Value
Accept	The requested content type (required for Index and Show actions). Fill this with either 'text/xml' or 'application/json'. See Response Formats	text/xml
User-Agent	An identifier you choose for your client software	Rackspace Management Interface
X-Api-Signature	An authentication string explained in detail here	eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=

Form Data

When using Add and Edit operations, the details of the resource are sent to the API server via HTTP form data. Your HTTP library should include methods for sending form data along with an HTTP request. The library should by default send the data in the HTTP request body using the 'application/x-www-form-urlencoded' data format.

Index Filter/Search

The results of Index actions can be filtered/searched. The index URLs can take either one of the query strings: "?startswith=xx" or "?contains=xx," where "xx" is the key word. If the request specifies more than one of these two query strings, a 400 HTTP error will be returned. Different fields will be searched depending on the resource type, see below.

Note that "0-9" is a reserved key word for query string "startswith." It represents any result starting with numbers.

Index Actions	Where the key word will be searched
Customer	Customer name, account number, reference number
Domain	Domain name
Mailbox	Mailbox name, mailbox display name
Contact	Contact display name, external email
Group	Group name, group display name
Mobile Service	Associated mailbox name, mailbox display name

Throttling

The server limits the number of requests allowed per user in a certain period of time. The number of requests made are logged per minute. Calls that were made correctly with a user's API key, but not completed for any reason, including those exceeding the throttle limit, are included in this count.

If a user is over the throttling limit then a 403 HTTP code will be returned with an "Exceeded request limits" message.

Operation Category	Request Limit
GET	60 per minute
PUT, POST, DELETE	30 per minute
POST, PUT, DELETE on a domain	2 per minute
POST, DELETE on alternate domains	2 per minute
Enabling public folders for a domain	1 per 5 minutes

Examples

Index of Exchange Mailboxes:

Hypertext Transfer Protocol
    GET /v0/customers/12345678/domains/example.com/ex/mailboxes?size=100&offset=100 HTTP/1.1
    Host: api.emailsrvr.com
    User-Agent: Rackspace Management Interface
    X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
    Accept: text/xml

Adding New Exchange Mailbox:

Hypertext Transfer Protocol
    POST /v0/customers/12345678/domains/example.com/ex/mailboxes/john.smith HTTP/1.1
    Host: api.emailsrvr.com
    User-Agent: Rackspace Management Interface
    X-Api-Signature: eGbq9/2hcZsRlr1JV1Pi:20010317143725:HKUn0aajpSDx7qqGK3vqzn3FglI=
    Content-Length: 53
        [Content length: 53]
    Content-Type: application/x-www-form-urlencoded
 
Line-based text data: application/x-www-form-urlencoded
    size=2048&displayName=John%20Smith&password=abcABC123

Responses

HTTP Status Code

On a successfully executed request, a 200 HTTP Code is returned. If the request was unsuccessful however, an HTTP error code in the 400s or 500s will be returned.

HTTP Response Body

If the request is an Index or Show request, the request data will be returned in the format specified in the HTTP Body.

Formats

Requests for data (index and show requests) are returned with XML or JSON data based on what your application populates the HTTP Accept headers with.

For XML, populate the header with 'text/xml' (ex: Headers!["Accept"] = "text/xml"). The XML document returned will conform to a published XSD (XML Schema Document). There are many ways to parse the data in an XML document, but we have found that the XPath tree-style traversal has served our purposes. In any case, your application will likely need to use a class library for your chosen method.

For JSON, populate the header with 'application/json' (ex: Headers!["Accept"] = "application/json"). As with XML, a library will likely be needed to parse the data.

HTTP Headers

The only data returned in the header is the error message (if any).

Header Name	Description	Example Header Value
x-error-message	The error message. See Errors.	Missing required field: name

Errors

When an error occurs, the system will return an HTTP error response code denoting the type of error. The system will also return additional information about the fault in the body of the response.

Example Fault Response – XML

<appsFault code="500">
  <message>Fault!</message>
  <details>Error Details...</details>
</appsFault>

Example Fault Response – JSON

{
  "appsFault" : {
    "code" : 500,
    "message" : "Fault!",
    "details" : "Error Details..."
  }
}

The error code is returned in the body of the response for convenience. The message section returns a human-readable message that is appropriate for display to the end user. The details section is optional and may contain information—for example, a stack trace—to assist in tracking down an error. The detail section may or may not be appropriate for display to an end user. The root element of the fault (e.g. appsFault) may change depending on the type of error. The following is a list of possible common root elements along with their associated error codes. More specific faults may be may exist for different resources and will be documented with those resources.

Fault Element	Error Codes	Custom Fields
appsFault	500, 400, and other codes
itemNotFound	404	resourceType - What resource in the request that was not found (Domain, Mailbox, etc.)
unauthorized	403
badRequest	400

From an XML schema perspective, all API faults are extensions of the base fault type AppsAPIFault. When working with a system that binds XML to actual classes (such as JAXB), one should be capable of using AppsAPIFault as a “catch-all” if there's no interest in distinguishing between individual fault types.

X-Error-Message Header

Prior to faults in the body of HTTP responses, the only information returned to users was the HTTP status code and an HTTP header x-error-message with the error message. This functionality has been kept for backwards compatibility but retrieving fault information in the HTTP body is the recommended approach for new applications.

Paging

The results of Index actions are split into pages to lessen potentially high resource usage. The index URLs have a query string with parameters in the format "?size=xx&offset=xx." If a query parameter is omitted, the default value is used.

Query Parameter	Default	Maximum	Notes
size	50	250	This is the number of elements per page.
offset	0	N/A	This is the number of items to offset away from the first item in the list.

Example

A PHP Example of paging can be found here.

Examples

HTTP/1.1 200 OK
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.0
Date: Fri, 04 Dec 2009 19:08:11 GMT
Content-Length: 430

<?xml version="1.0" encoding="utf-8"?>
<domainList xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="urn:xml:domainList">
  <offset>0</offset>
  <size>50</size>
  <total>1</total>
  <domains>
    <domain>
      <name>customer.com</name>
      <accountNumber>123456</accountNumber>
      <serviceType>rsemail</serviceType>
    </domain>
  </domains>
</domainList>

HTTP/1.1 404 Not Found
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Customer Not Found
Date: Fri, 04 Dec 2009 19:13:59 GMT
Content-Length: 0

HTTP/1.1 400 Bad Request
Cache-Control: private
Server: Microsoft-IIS/7.0
x-error-message: Missing required field: type
Date: Fri, 04 Dec 2009 19:17:29 GMT
Content-Length: 0

Examples

Ruby

This examples is written in Ruby. To make the examples shorter, helper methods have been written. These methods are part of a NetMethods module. The contents of the NetMethods module is listed below.

require  'server.rb'

server = Server.new

response = server.get  '/customers', server.xml_format

#fields = Hash['serviceType' =>  'exchange', 'exchangeMaxNumMailboxes' => '4']
#response =  server.post '/customers/me/domains/newdomain.com', fields

puts response.code
puts response['x-error-message']
puts response.body

require 'test/unit/assertions'
require 'net/http'
require 'date'
require 'date/format'
require 'digest/sha1'
require 'base64'
require 'time'

class Server
  include Test::Unit::Assertions
  
  def initialize(server='api.emailsrvr.com', version_prefix='/v0', user_key='xxxxxxxxxxxxxxxxxxxx', secret_hash='xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')
    @server = server
    @version_prefix = version_prefix
    @user_key = user_key
    @secret_hash = secret_hash
  end
  
# Response Type Enums

  def xml_format
    'text/xml'
  end
  
  def json_format
    'application/json'
  end

#
# HTTP Request Verbs
#  
  def get(url_string, format)
    uri = full_uri(url_string)
    headers = prepared_headers
    headers['Accept'] = format
    request = Net::HTTP::Get.new(request_uri(uri), headers)
    http_response = make_request request, uri
  end
  
  def delete(url_string)
    uri = full_uri(url_string)
    request = Net::HTTP::Delete.new(request_uri(uri), prepared_headers)
    http_response = make_request request, uri
  end
  
  def put(url_string, fields_hash)
    uri = full_uri(url_string)
    request = Net::HTTP::Put.new(request_uri(uri), prepared_headers)
    request.set_form_data(fields_hash)
    http_response = make_request request, uri
  end
  
  def post(url_string, fields_hash)
    uri = full_uri(url_string)
    request = Net::HTTP::Post.new(request_uri(uri), prepared_headers)
    request.set_form_data(fields_hash)
    http_response = make_request request, uri
  end
  
#
# HTTP Request Helpers
# 
  def make_request request, uri
    response = Net::HTTP::start(uri.host, uri.port)  do |http|
      http.request request
    end
    
    response
  end
  
  def full_uri url_string
    URI.parse('http://' + @server + @version_prefix + url_string)
  end
  
  def request_uri uri
    request = uri.path
    if ! uri.query.nil?
      request = request + '?' + uri.query
    end
    request
  end
  
  def prepared_headers
    headers = Hash.new
    headers.merge! headers_auth_creds(@user_key, @secret_hash)
    headers['Accept'] = xml_format
    headers
  end
  
  def headers_auth_creds apiKey, secretKey
    userAgent = 'Ruby Test Client'
    timestamp = DateTime.now.strftime('%Y%m%d%H%M%S')
    
    data_to_sign = apiKey + userAgent + timestamp + secretKey
    
    hash = Base64.encode64(Digest::SHA1.digest(data_to_sign))
    signature = apiKey + ":" + timestamp + ":" + hash
    
    headers = Hash['User-Agent' => userAgent, 'X-Api-Signature' => signature]
  end
end

C#

This examples is written in C#.

using System;
using System.Collections.Specialized;
using System.Security.Cryptography;
using System.Text;
using System.Net;

public class WebMethods
{
  private WebClientBase client;
  private string baseUrl;
  private string apiKey;
  private string secretKey;

  public WebMethods(WebClientBase client, string baseUrl, string apiKey, string secretKey)
  {
    this.client = client;
    this.baseUrl = baseUrl;
    this.apiKey = apiKey;
    this.secretKey = secretKey;
  }

  public virtual string Get(string url)
  {
    return MakeRemoteCall((client) =>
      {
        return client.DownloadString(baseUrl + url);
      },
      format);
  }

  public virtual string Post(string url, NameValueCollection data)
  {
    return MakeRemoteCall((client) =>
      {
        var bytes = client.UploadValues(baseUrl + url, data);
        return Encoding.UTF8.GetString(bytes);
      },
      format);
  }

  private void SignMessage()
  {
    var userAgent = "C# Client Library";
    client.Headers["User-Agent"] = userAgent;

    var dateTime = DateTime.UtcNow.ToString("yyyyMMddHHmmss");

    var dataToSign = apiKey + userAgent + dateTime + secretKey;
    var hash = SHA1.Create();
    var signedBytes = hash.ComputeHash(Encoding.UTF8.GetBytes(dataToSign));
    var signature = Convert.ToBase64String(signedBytes);

    client.Headers["X-Api-Signature"] = apiKey + ":" + dateTime + ":" + signature;
  }

  private void AssignFormat(string format)
  {
    client.Headers["Accept"] = format;
  }

  private string MakeRemoteCall(Func<WebClientBase, string> remoteCall, string format)
  {
    try
    {
      SignMessage();
      AssignFormat(format);
      return remoteCall.Invoke(client);
    }
    catch (WebException e)
    {
      throw new ApiException(e);
    }
  }
}

PHP

The PHP Example can be found here.

@@ Line 528: / Line 528: @@
 ==== Errors ====
-In the event of an error, the error message will be returned the HTTP header '''x-error-message''' and an HTTP Status Code in the '''400'''s or '''500'''s will be returned.
+When an error occurs, the system will return an HTTP error response code denoting the type of error. The system will also return additional information about the fault in the body of the response.
-Note: Every language's HTTP library provides methods for retrieving HTTP response codes and response headers.
+'''Example Fault Response – XML'''
+<pre>
+<appsFault code="500">
+  <message>Fault!</message>
+  <details>Error Details...</details>
+</appsFault>
+</pre>
-Below are some errors that are common to many operations. Each operation also has some specific errors which are outlined with the operation.
+'''Example Fault Response – JSON'''
+<pre>
+{
+  "appsFault" : {
+    "code" : 500,
+    "message" : "Fault!",
+    "details" : "Error Details..."
+  }
+}
+</pre>
+The error code is returned in the body of the response for convenience. The message section returns a human-readable message that is appropriate for display to the end user. The details section is optional and may contain information—for example, a stack trace—to assist in tracking down an error. The detail section may or may not be appropriate for display to an end user.
+The root element of the fault (e.g. appsFault) may change depending on the type of error. The following is a list of possible common root elements along with their associated error codes.  More specific faults may be may exist for different resources and will be documented with those resources.
 {| class="wikitable"
-!''Description''
+!''Fault Element''
-!''HTTP Response Code''
+!''Error Codes''
-!''Sample Message''
+!''Custom Fields''
-|-
-|Format is invalid
-|400
-|When requesting an index or show on a resource the 'Accept' header should be either 'text/xml' or 'application/json'
-|-
-|Expectation  Failed: See [[Handling HTTP code 417: Expectation failed]]
-|417
-|(none)
-|-
-|Customer account number is invalid
-|404
-|Invalid account number
 |-
-|Domain is not found
+|appsFault
-|404
+|500, 400, and other codes
-|<domain name> not found
+|
 |-
-|Mailbox is not found
+|itemNotFound
 |404
-|Mailbox not found
+|resourceType - What resource in the request that was not found (Domain, Mailbox, etc.)
 |-
-|Required form field is missing
+|unauthorized
-|400
+|403
-|Missing required field: <required field>
+|
 |-
-|Required form field has null or empty string input
+|badRequest
 |400
-|Required field <required field> cannot be empty
+|
-|-
-|Integer form field has non-integer input
-|400
-|Invalid format for <field>, input must be an integer
-|-
-|Boolean form field has non-boolean input
-|400
-|Invalid format for <field>, input must be True or False
-|-
-|Form data has an unrecognized field
-|400
-|Unrecognized field: <field>
-|-
-| Entered invalid IP address
-| 400
-| invalid ip address: 123
 |}
+From an XML schema perspective, all API faults are extensions of the base fault type AppsAPIFault. When working with a system that binds XML to actual classes (such as JAXB), one should be capable of using AppsAPIFault as a “catch-all” if there's no interest in distinguishing between individual fault types.
+'''X-Error-Message Header'''
+Prior to faults in the body of HTTP responses, the only information returned to users was the HTTP status code and an HTTP header x-error-message with the error message.  This functionality has been kept for backwards compatibility but retrieving fault information in the HTTP body is the recommended approach for new applications.
 ==== Paging ====

Difference between revisions of "Main Page"

Revision as of 09:40, 11 August 2011

Contents

Introduction

Recent Changes

Operations

Quick Start

Accessing the API

Versions

Authentication

X-Api-Signature Header

Using the API

Requests

URL

HTTP Method

HTTP Headers

Form Data

Index Filter/Search

Throttling

Examples

Responses

HTTP Status Code

HTTP Response Body

Formats

HTTP Headers

Errors

Paging

Example

Examples

Examples

Ruby

C#

PHP

Navigation menu

Views

Personal tools

Navigation

Search

Tools