Getting started

The API is entirely HTTP-based

Methods to retrieve data from the Piictu API require a GET request. Methods that submit, change, or destroy data require a POST, PUT or DELETE. API Methods that require a particular HTTP method will return an error if you do not make your request with the correct one. HTTP Response Codes are meaningful.

In case the client used to access the API doesn't support PUT / DELETE requests, the request can be done using a POST and adding an special parameter _method with value put or delete depending the case.

The API is a RESTful resource

The Piictu API attempts to conform to the design principles of Representational State Transfer (REST). Currently the API only support JSON format.

Parameters have certain expectations

Some API methods take optional or requisite parameters. Things to keep in mind when making requests with parameters:

• Parameter values should be converted to UTF-8 and URL encoded.
• The page parameter begins at 1, not 0.

Authentication and Authorization.

Piictu API use OAuth 2.0 - http://tools.ietf.org/html/draft-ietf-oauth-v2-10 for clients authorization. Check in Authentication and Authorization section how to use it.

In order to use our API you will need to have an OAuth account registered in our servers. If you would like one, please send us an email at support@piictu.com and we will be happy to provide it for you.