Documentation

If you are running a PHP-based server the PHP SDK would be the perfect fit for you.

To download it you can either:

  1. Use the direct link to download the PHP SDK
  2. Download from or fork our PHP SDK Github repository.
Fork me on GitHub
To use the methods from SDK in your code you would need to include it first. To include PHP SDK you would use the following call:
<?php require_once('./ziggeo/Ziggeo.php');
$ziggeo = new Ziggeo('YOUR APP TOKEN', 'YOUR_APP_PRIVATE_KEY', 'YOUR_APP_ENCRYPTION_KEY'); ?>
Calling methods is as simple as:
$ziggeo->resource()->method(args)
The following is the list of methods and their function calls

videos

  • index
    $ziggeo->videos()->index($arguments = array())
    
    Returns JSON
    [
    	{
    	"volatile":false,
    	"token":"a7edab8c635ec37047d8ae75411528e3",
    	"key":null,
    	"state":5,
    	"max_duration":null,
    	"duration":1,
    	"tags":null,
    	"submission_date":1390257799,
    	"resubmission_date":1390257799,
    	"stream_submission_date":1390257799,
    	"delete_old_streams":true,
    	"type":"ApiVideo",
    	"created":1390257798,
    	"owned":false,
    	"state_string":"READY",
    	"streams":[
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}],
    	"original_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	},
    	"default_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}}]
    
    1. limit Limit the number of returned videos. Can be set up to 100.
    2. skip Skip the first [n] entries.
    3. reverse Reverse the order in which videos are returned.
    4. states Filter videos by state
    5. tags Filter the search result to certain tags, encoded as a comma-separated string
  • count
    $ziggeo->videos()->count($arguments = array())
    
    Returns JSON
    1. states Filter videos by state
    2. tags Filter the search result to certain tags, encoded as a comma-separated string
  • get
    $ziggeo->videos()->get($token_or_key)
    
    Returns JSON
    {
    	"volatile":false,
    	"token":"a7edab8c635ec37047d8ae75411528e3",
    	"key":null,
    	"state":5,
    	"max_duration":null,
    	"duration":1,
    	"tags":null,
    	"submission_date":1390257799,
    	"resubmission_date":1390257799,
    	"stream_submission_date":1390257799,
    	"delete_old_streams":true,
    	"type":"ApiVideo",
    	"created":1390257798,
    	"owned":false,
    	"state_string":"READY",
    	"streams":[
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}],
    	"original_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	},
    	"default_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}}
    
  • get_bulk
    $ziggeo->videos()->get_bulk($arguments = array())
    
    Returns JSON
    1. tokens_or_keys Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).
  • download_video
    $ziggeo->videos()->download_video($token_or_key)
    
    Returns DATA
  • download_image
    $ziggeo->videos()->download_image($token_or_key)
    
    Returns DATA
  • push_to_service
    $ziggeo->videos()->push_to_service($token_or_key, $arguments = array())
    
    Returns JSON
    1. pushservicetoken Push Services's token (from the Push Services configured for the app)
  • apply_effect
    $ziggeo->videos()->apply_effect($token_or_key, $arguments = array())
    
    Returns JSON
    1. effectprofiletoken Effect Profile token (from the Effect Profiles configured for the app)
  • update
    $ziggeo->videos()->update($token_or_key, $arguments = array())
    
    Returns JSON
    {
    	"volatile":false,
    	"token":"a7edab8c635ec37047d8ae75411528e3",
    	"key":"brandnewname",
    	"state":5,
    	"max_duration":"10",
    	"duration":1,
    	"tags":null,
    	"submission_date":1390257799,
    	"resubmission_date":1390257799,
    	"stream_submission_date":1390257799,
    	"delete_old_streams":true,
    	"type":"ApiVideo",
    	"created":1390257798,
    	"owned":false,
    	"state_string":"READY",
    	"streams":[
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}],
    	"original_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	},
    	"default_stream":
    	{
    		"volatile":false,
    		"token":"d751140b4e1cf0a243f32092f6110296",
    		"key":null,
    		"creation_type":5,
    		"state":5,
    		"streamable":2,
    		"video_type":"mp4",
    		"video_sub_type":"other",
    		"image_size":0,
    		"video_size":36078,
    		"video_width":640,
    		"video_height":360,
    		"duration":1,
    		"has_video":true,
    		"has_image":true,
    		"submission_date":1390257799,
    		"type":"ApiVideoStream",
    		"created":1390257799,
    		"owned":true,
    		"creation_type_string":"SERVER_UPLOAD",
    		"streamable_string":"DEGRADED",
    		"state_string":"READY"
    	}}
    
    1. min_duration Minimal duration of video
    2. max_duration Maximal duration of video
    3. tags Video Tags
    4. key Unique (optional) name of video
    5. volatile Automatically removed this video if it remains empty
    6. expiration_days After how many days will this video be deleted
  • update_bulk
    $ziggeo->videos()->update_bulk($arguments = array())
    
    Returns JSON
    1. tokens_or_keys Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).
    2. min_duration Minimal duration of video
    3. max_duration Maximal duration of video
    4. tags Video Tags
    5. volatile Automatically removed this video if it remains empty
    6. expiration_days After how many days will this video be deleted
  • delete
    $ziggeo->videos()->delete($token_or_key)
    
  • create
    $ziggeo->videos()->create($arguments = array())
    
    Returns JSON
    {
    	"volatile":true,
    	"token":"a7edab8c635ec37047d8ae75411528e3",
    	"key":null,
    	"state":3,
    	"max_duration":null,
    	"duration":null,
    	"tags":null,
    	"submission_date":null,
    	"resubmission_date":null,
    	"stream_submission_date":null,
    	"delete_old_streams":true,
    	"type":"ApiVideo",
    	"created":1390257798,
    	"owned":false,
    	"state_string":"EMPTY",
    	"streams":[],
    	"original_stream":null,
    	"default_stream":null
    }
    
    1. file Video file to be uploaded
    2. min_duration Minimal duration of video
    3. max_duration Maximal duration of video
    4. tags Video Tags
    5. key Unique (optional) name of video
    6. volatile Automatically removed this video if it remains empty
  • analytics
    $ziggeo->videos()->analytics($token_or_key, $arguments = array())
    
    Returns JSON
    1. from A UNIX timestamp in microseconds used as the start date of the query
    2. to A UNIX timestamp in microseconds used as the end date of the query
    3. date A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.
    4. query The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser

streams

  • index
    $ziggeo->streams()->index($video_token_or_key, $arguments = array())
    
    Returns JSON
    [
    	{
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }]
    
    1. states Filter streams by state
  • get
    $ziggeo->streams()->get($video_token_or_key, $token_or_key)
    
    Returns JSON
    {
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }
    
  • download_video
    $ziggeo->streams()->download_video($video_token_or_key, $token_or_key)
    
    Returns DATA
  • download_image
    $ziggeo->streams()->download_image($video_token_or_key, $token_or_key)
    
    Returns DATA
  • push_to_service
    $ziggeo->streams()->push_to_service($video_token_or_key, $token_or_key, $arguments = array())
    
    Returns JSON
    1. pushservicetoken Push Services's token (from the Push Services configured for the app)
  • delete
    $ziggeo->streams()->delete($video_token_or_key, $token_or_key)
    
  • create
    $ziggeo->streams()->create($video_token_or_key, $arguments = array())
    
    Returns JSON
    {
    	"volatile":false,
    	"token":"d751140b4e1cf0a243f32092f6110296",
    	"key":null,
    	"creation_type":5,
    	"state":5,
    	"streamable":2,
    	"video_type":"mp4",
    	"video_sub_type":"other",
    	"image_size":0,
    	"video_size":36078,
    	"video_width":640,
    	"video_height":360,
    	"duration":1,
    	"has_video":true,
    	"has_image":true,
    	"submission_date":1390257799,
    	"type":"ApiVideoStream",
    	"created":1390257799,
    	"owned":true,
    	"creation_type_string":"SERVER_UPLOAD",
    	"streamable_string":"DEGRADED",
    	"state_string":"READY"
    }
    
    1. file Video file to be uploaded
  • attach_image
    $ziggeo->streams()->attach_image($video_token_or_key, $token_or_key, $arguments = array())
    
    Returns JSON
    1. file Image file to be attached
  • attach_video
    $ziggeo->streams()->attach_video($video_token_or_key, $token_or_key, $arguments = array())
    
    Returns JSON
    1. file Video file to be attached
  • bind
    $ziggeo->streams()->bind($video_token_or_key, $token_or_key, $arguments = array())
    
    Returns JSON

authtokens

  • get
    $ziggeo->authtokens()->get($token)
    
    Returns JSON
  • update
    $ziggeo->authtokens()->update($token_or_key, $arguments = array())
    
    Returns JSON
    1. volatile Will this object automatically be deleted if it remains empty?
    2. hidden If hidden, the token cannot be used directly.
    3. expiration_date Expiration date for the auth token
    4. usage_experitation_time Expiration time per session
    5. session_limit Maximal number of sessions
    6. grants Permissions this tokens grants
  • delete
    $ziggeo->authtokens()->delete($token_or_key)
    
  • create
    $ziggeo->authtokens()->create($arguments = array())
    
    Returns JSON
    1. volatile Will this object automatically be deleted if it remains empty?
    2. hidden If hidden, the token cannot be used directly.
    3. expiration_date Expiration date for the auth token
    4. usage_experitation_time Expiration time per session
    5. session_limit Maximal number of sessions
    6. grants Permissions this tokens grants

effectProfiles

  • create
    $ziggeo->effectProfiles()->create($arguments = array())
    
    Returns JSON
    1. key Effect profile key.
    2. title Effect profile title.
  • index
    $ziggeo->effectProfiles()->index($arguments = array())
    
    Returns JSON
    1. limit Limit the number of returned effect profiles. Can be set up to 100.
    2. skip Skip the first [n] entries.
    3. reverse Reverse the order in which effect profiles are returned.
  • get
    $ziggeo->effectProfiles()->get($token_or_key)
    
    Returns JSON
  • delete
    $ziggeo->effectProfiles()->delete($token_or_key)
    

effectProfileProcess

  • index
    $ziggeo->effectProfileProcess()->index($effect_token_or_key, $arguments = array())
    
    Returns JSON
    1. states Filter streams by state
  • get
    $ziggeo->effectProfileProcess()->get($effect_token_or_key, $token_or_key)
    
    Returns JSON
  • delete
    $ziggeo->effectProfileProcess()->delete($effect_token_or_key, $token_or_key)
    
  • create_filter_process
    $ziggeo->effectProfileProcess()->create_filter_process($effect_token_or_key, $arguments = array())
    
    Returns JSON
    1. effect Effect to be applied in the process
  • create_watermark_process
    $ziggeo->effectProfileProcess()->create_watermark_process($effect_token_or_key, $arguments = array())
    
    Returns JSON
    1. file Image file to be attached
    2. vertical Specify the vertical position of your watermark (a value between 0.0 and 1.0)
    3. horizontal Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
    4. scale Specify the image scale of your watermark (a value between 0.0 and 1.0)

webhooks

  • create
    $ziggeo->webhooks()->create($arguments = array())
    
    Returns string
    1. target_url The url that will catch the events
    2. encoding Data encoding to be used by the webhook to send the events.
    3. events Comma-separated list of the events the webhook will catch. They must be valid webhook type events.
  • delete
    $ziggeo->webhooks()->delete($arguments = array())
    
    Returns string
    1. target_url The url that will catch the events

analytics

  • get
    $ziggeo->analytics()->get($arguments = array())
    
    Returns JSON
    1. from A UNIX timestamp in microseconds used as the start date of the query
    2. to A UNIX timestamp in microseconds used as the end date of the query
    3. date A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.
    4. query The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser