Zoopy REST API Documentation

Calling API methods

Methods in this API should be called as regular HTTP requests. The HTTP request method needed in each instance is specified in this document, and as mentioned in the introduction all URLs below are relative to http://api.zoopy.com. The values in parentheses indicate a variable. Accepted values will depend on the circumstance, but in general the following holds:

Authentication

Each API request requires that your Zoopy username and password be sent. The API implements basic HTTP authentication. Failure to provide these credentials will result in a 401.

HTTP Response Codes

In line with the RESTful style, all methods in this API respond with meaningful HTTP codes. The response codes depend on the request, but the following response codes are returned by all methods:

Response content

Each response will contain a flag to tell you whether or not the response is an error or the requested content. Below are what you can expect for errors/successes in both XML and JSON:

<result type="error">
	<title>Not found</title>
	<message>The requested media 
	item does not exist.</message>
	<httpCode>404</httpCode>
</result>

{
	"result":"error",
	"content":{
		"title":"Not found",
		"message":"The requested media item does not exist.",
		"httpCode":404
	}
}

<result type="success">
	<media uri="http://api.zoopy.com/rest/media/1.xml">
		<type>photo</type>
		<title><![CDATA[MCQP Laser Show]]></title>
	</media>
</result>

{
	"result":"success",
	"content":{
		"media":{
			"uri":"http:\/\/api.zoopy.com\/rest\/media\/1.json",
			"type":"photo",
			"title":"MCQP Laser Show"
		}
	}
}

PHP Client