REST

The Adobe Online Marketing Suite REST interface provides an alternative to SOAP for programmatically accessing Web services. The REST interface is available to access all methods in the following Online Marketing Suite APIs:

Both Test&Target;™ and Recommendations™ use a REST interface exclusively. For more information about each of these APIs, see Test&Target; APIs and Recommendations APIs.

Using REST

The REST interface lets you call methods from the Online Marketing Suite APIs using HTTP GET or POST requests. The REST interface fully supports methods that require multiple parameters. To use Web Services in your SiteCatalyst report suite, you must have Web Services access privileges. For more information, see Enabling Web Services Access.

You can construct REST requests using the Web Services method name and the parameters required for that method. To execute a REST request, make an HTTP GET or HTTP POST request to the Online Marketing Suite REST endpoint.

HTTP GET (Read-only) method call

Specify method parameters in an HTTP GET request as URL query string parameters. For example:

         GET /admin/1.2/rest/?method=&param1Name;=param1value&param2Name;=param2Value...&paramNname;=paramNvalue HTTP/1.1
           Host: https://api.omniture.com
           X-WSSE: Authentication Credentials (see Web Services Authentication)

HTTP POST (Write) method call

Specify method parameters in an HTTP POST request as JSON object keys in the content body. For example:

           POST /p/am/1.2/rest-api.html?method=Report.QueueRanked HTTP/1.1
           Host: api.omniture.com
           X-WSSE: Authentication Credentials (see Web Services Authentication)
           Content-Length: 100
              { "param1": "foo", "param2": "bar", "param3": "value" }

REST Responses

Responses to all API calls using the REST interface are encoded in JavaScript Object Notation (JSON). Complex response use a JSON object or array, while single value responses use a JSON value (number, string, or boolean). For more information about JSON visit http://www.json.org.