Cincopa API

This page contains extended documentation and links about the Cincopa API. With the API, you can create your application that utilizes each user's media.

REST Interface

The API uses a REST-like interface. This means that Cincopa method calls are made over the internet by sending HTTP GET or POST requests to the Cincopa API REST server. Nearly any computer language can be used to communicate over HTTP with the REST server.

The REST server is at


The Cincopa API expects all data to be UTF-8 encoded. Click for more information about UTF-8

User Authentication

Many methods require the user to be logged in. At present there is only one way to accomplish this. Direct your users to: ALTERNATIVE_URL_REDIRECT_AFTER_LOGIN - This will prompt the user to log in if necessary.

Upon successful authentication, if the user has never logged in to this application before, they will be asked to accept the terms of service for using the application. Finally, they are redirected to the site's Landing_Page (as defined in your application parameters) or according to the "continue" parameter (from the login url) + user_token=XXXXXX.

user_token represents a user authenticated session and should be exchange for a session id (sid) via the auth.getUserSession method. The sid is required to call all other API methods.

Signature Algorithm

The signature argument is used by every API method to authenticate the request and make sure that it was not altered.

The signature is constructed using the following algorithm (after all the other arguments have been determined):

foreach(arg in array of args)
   args = concatenate(args, arg key, arg val) // formatted in non-urlencoded

sorted_array = alphabetically_sort_array_by_keys(args);
request_str = concatenate_in_order(sorted_array);
signature = md5(concatenate(request_str, secret))

Storing Data in User and Folder Objects

The application can attach data that it collects or generates to a user and folder objects.
Get more details about StoreDataAPI.

Was this page helpful? Your feedback helps improve this site.
Thank you! Any other feedback?