SIGN IN
DOCUMENTATION:
Overview Embedding Customizing Scripting Rest Api Callback

REST API

To retrieve information about or to delete a video, you can use the following REST methods.

GET /api/videos/:name

Use this endpoint to get data about a specific video.

Request parameters

  • api_key , time_stamp , and signature as described in Authentication
  • name: The video's UUID within the Framey system

Example request 
http://framey.com/api/videos/ba9bd910-549d-012e-32f4-549a20bdfc52?
api_key=7VNKGLJZLKSASZ0FXN2TVSZQU&
signature=41B08D68E0A4AC2DD91107BBD6AD08B8&
time_stamp=1304447242
Example response 
{
  "video":{
    "duration":60,
    "name":"ba9bd910-549d-012e-32f4-549a20bdfc52",
    "data":{"user_id":1},
    "large_thumbnail_url":"http://framey.com/thumbnails/large/ba9bd910-549d-012e-32f4-549a20bdfc52.jpg",
    "medium_thumbnail_url":"http://framey.com/thumbnails/medium/ba9bd910-549d-012e-32f4-549a20bdfc52.jpg",
    "small_thumbnail_url":"http://framey.com/thumbnails/small/ba9bd910-549d-012e-32f4-549a20bdfc52.jpg",
    "flv_url":"http://framey.com/videos/source/ba9bd910-549d-012e-32f4-549a20bdfc52.flv",
    "mp4_url":"http://framey.com/videos/source/ba9bd910-549d-012e-32f4-549a20bdfc52.mp4",
    "views":50,
    "filesize":1048576,
    "state":"recorded"},
  "success":true
}

DELETE /api/videos/:name

Delete the video with the given name.

Request parameters

  • api_key , time_stamp , and signature as described in Authentication
  • name: The video's UUID within the Framey system


Example request 
http://framey.com/api/videos/ba9bd910-549d-012e-32f4-549a20bdfc52?
api_key=7VNKGLJZLKSASZ0FXN2TVSZQU&
signature=41B08D68E0A4AC2DD91107BBD6AD08B8&
time_stamp=1304447242
Example response 
{
  "success":true
}

Authentication

When making a request to one of the above REST Endpoints you will need to provide the following three parameters:

  • api_key
  • time_stamp
  • signature

A description of each is below.

api_key

This is simply the API key that is generated for you when you sign up. It can be found on your account page.

time_stamp

This needs to be a UNIX timestamp of some date in the future after which the request should expire and hence be invalid. So if you want your request to expire after 15 minutes, the timestamp should be fifteen minutes in the future. For example, here is the timestamp for fifteen minutes from now: 

1368893432
signature

The signature is the parameter that prevents your API request from being spoofed. It is generated in the following way:

  1. Append the ampersand symbol to your API secret (which can be found on your account page)
  2. Append the UNIX timestamp you are using as the time_stamp parameter to the end of that
  3. Take the MD5 sum of the resulting string

For example, if your API secret were Q7MFGLRGY7BJBEJSZWLNR3N2X and your time_stamp were 1304448791, you would generate your signature like so: 

MD5("Q7MFGLRGY7BJBEJSZWLNR3N2X&1304448791")