AnyClip API


Overview

The AnyClip API allows you to build applications using motion picture video clips and metadata from AnyClip's vast video clip database. The database is searchable through the API and enables you access and use all the data and clips returned through a range of API Get and Post methods.
Access and usage of this data is governed by the AnyClip License Agreement. By using the AnyClip API, using the API you consent to the terms of the AnyClip License Agreement. Please review the License Agreement before registering for access.

Developer Community

Join the developer Google Group at http://groups.google.com/group/anyclip-api.
 


Registration

Access to the API is provided by registration. To register, fill out and submit the short registration form. A customer ID (CID) and an appKey will be sent to you.  


Authentication

The appKey is confidential and is used to create the signature hash, but does not appear in the final URL calls sent to the API. After you hash the call string, remove the appKey and append the hash to the end of the URL. The appKey parameter is only used when calculating the sig, and is not sent in the final request. Both the CID and [sig] SHA-1 value must be included in all calls sent to the API.
 
All calls to the API require authentication. Calls are authenticated by appending a SHA-1 signature hash to the query url.
  1. Construct your query: http:apis.anyclip.com/api/[method]/?[urlparams]&cid=[cid]&format=[format]

    Note: The format parameters is optional. Supported formats are JSON and XML. If neither are specified, the format defaults to XML.
  2. Add the appKey and sort your argument list (including the appKey) into alphabetical order based on the parameter name. If there are arguments with similar name, sort such arguments by values

    Note: It is important that all parameters including the appKey are indexed alphabetically. Failure to do so will generate error 1009 BadInputException.
  3. Hash the entire string using SHA-1. This creates the signature.
  4. Remove the appKey from the string and append the SHA-1 hash to the end of the call.

Call Signature

Where [sig] = is a SHA-1 hash value of the request string and all the request parameters and their values, cid (mandatory), and the app-key (mandatory), concatenated with an `&` sign as a separator, and indexed alphabetically.
 

Example

Suppose there are the following parameters for the request:
    b=v1, a=a2, a=a3, a=a4, vd=v3, and c=v4, appKey=[app-key], cid=[cid] (with or without the format param)
In such a case, the sig will be a SHA-1 value of the following string: 
An input for the SHA-1 will be:
/api/[method]/?a=a2&a=a3&a=a4&appKey=[app-key]&b=v1&c=v4&cid=[cid]&d=v3[&format=[format]
 

Call Authentication

To authenticate the call, AnyClip API will remove the sig, insert the API key associated with your CID, rehash the query, and compare the signature generated with the one received. If they match, the signature is authenticated and the call is run on the API.