Overview

This section discusses the platform's REST API. Individual documentation for the constituent parts of the API is located below:

• Ushahidi Public API
• Ushahidi Admin API
• Ushahidi API Status Messages

The remainder of this section outlines concepts that are applicable to the entire API (

Base URL

Unless otherwise specified the base URL for all API requests is:

http://<deplyment_url>/api

NOTE: All requests are submitted through HTTP GET or POST and they must be UTF-8 encoded.

Response Type

The response type parameter, resp, specifies the desired output format of the requested data. The API supports both XML and JSON output formats with the latter being the default.

JSON Response

&resp=json

XML Response

&resp=xml