Documentation for Developers by Developers

The Rest API is the underlying interface for all our SDKs and it is the most direct way to access the API. This Rest API documentation is designed for those interested in developing for platforms not supported by the SDKs or for those interested in exploring the Rest API features in detail.

Here is what you need to know about communicating directly with the REST API:

Structure of your HTTP Request

With a limited number of exceptions, most requests will have:

1. An Endpoint URL. Each REST API method's documentation includes a JSON and an XML version of the Endpoint. For example, AppData Add's endpoint for JSON is https://service.proxomo.com/v09/json/appdata.
2. Headers:
   • "Authorization" Header: In order to identify your application as the one making the request, you need to send in the value of your Application Authorization Token. For example: Authorization: 8B34KH54ikZPBrqxrsYZ7IQQQQQJTIpOtM7AM+hF25E=
   • "Content-Type" and "Content-Length" Headers: These must be included if the length of the body is > 0. Note:
     • For JSON: Content-Type: application/json
     • For XML: Content-Type: text/xml
3. Body: Endpoints using the POST and PUT HTTP methods send in additional data in the body. This data is either in XML or JSON format.  For example, AppData Add sends in the contents of the AppData object to add in the body of its request.
    

Structure of your HTTP Response

1. Endpoints using the GET HTTP method receive data back in the body. This data is either in XML or JSON format. For example, AppData Get gets back the AppData object requested.