Requests
Request types
There are several types of request, categorised by their type of operation. For example, retrieving data is done with a GET request, adding new data with a POST request:
| Type | Purpose |
|---|---|
GET |
Accessing data such as journal entries or user info |
POST |
Publishing new data such as a comment |
PUT |
Not currently used |
DELETE |
Removing data such as removing a subscription |
Each request therefore takes the following form:
http://api.blipfoto.com/TYPE/RESOURCE/?PARAMS
Common parameters
All resources accept some common parameters in the URL:
| Parameter | Purpose | Required? |
|---|---|---|
api_key |
Your application's API Key must be sent with every request. | Yes |
format |
One of the following strings denoting the desired response format: XML, JSON or PHP |
No (XML is the default response format.) |
version |
The number of the API version you wish to use. Currently there are two versions, 1 and 2. |
No (the default is version 1) |
callback |
When the format value is JSON, you may wrap the response in a callback value for JSON-P compatibility. |
No |
request_id |
A unique value, defined by you, that can be passed back to help you match responses with requests - useful when transmitting asynchronous data. | No |
debug |
Set the value of this parameter to 1 and extra request data is added to the response, such as recieved parameters and file upload info. |
No |
nohttperror |
This parameter is deprecated. From V2 onwards, all responses will return a 200 OK status code regardless of any underlying API error.Set the value of this parameter to 1 and the response headers will always return a 200 OK message, regardless of any underlying API error code. |
No |
Example request
The code below is an example of a request to a fictional resource:
http://api.blipfoto.com/get/exampleResource/?api_key=4c297fc904&format=PHP&request_id=23