portal logo

VIMP API

This page describes the ways of accessing the VIMP API.

API Access is currently ENABLED. To disabled API access, contact your VIMP Administrator.

Methods

Description
Get version information
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
Description
Get config parameters
Parameters
apikey
name
comma-separated list of parameters
Optional parameters
token
format
one of "xml" or "json"
Description
Get all categories
Parameters
apikey
Optional parameters
parentid
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
Get a specific category using ID
Parameters
apikey
categoryid
Optional parameters
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category name
format
one of "xml" or "json"
Description
Get all media from a specified category
Parameters
apikey
categoryid
Optional parameters
token
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
orderby
one of "created", "uploaded", "updated" or "name"
sortdirection
one of "asc" or "desc"
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Delete a specific category using ID
Parameters
apikey
token
categoryid
Optional parameters
format
one of "xml" or "json"
subcategories
"true" if subcategories should be deleted as well
Description
Purge a specific category using ID
Parameters
apikey
token
categoryid
Optional parameters
format
one of "xml" or "json"
subcategories
"true" if subcategories should be purged as well
Description
Get all channels
Parameters
apikey
Optional parameters
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Get a specific channel using ID
Parameters
apikey
channelid
Optional parameters
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Get all media from a specified channel
Parameters
apikey
channelid
Optional parameters
token
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
orderby
one of "created", "uploaded", "updated" or "name"
sortdirection
one of "asc" or "desc"
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Add a medium to provided channel
Parameters
apikey
token
mediumid
medium id or media key
channelid
Optional parameters
format
one of "xml" or "json"
Description
Delete a medium from a channel
Parameters
apikey
token
mediumid
medium id or media key
channelid
Optional parameters
format
one of "xml" or "json"
Description
Get all media that the requesting user is allowed to access.
Parameters
apikey
Optional parameters
token
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
search
search within the title, description and tags
orderby
one of "created", "uploaded", "updated" or "name"
sortdirection
one of "asc" or "desc"
include_status
comma separated status list
offset
limit
thumbsize
width x height (ex. 210x108)
hidden
true, false
private
true, false
chapters
true, false
responsive
true, false
language
ISO-639-1 code for media category names
ownmediaonly
true, false - if set to true, only users own media will be returned by the API
format
one of "xml" or "json"
Description
Get a specific media using ID
Parameters
apikey
mediumid
medium id or media key
Optional parameters
token
password
thumbsize
width x height (ex. 210x108)
chapters
true, false
responsive
true, false
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
mediapermissions
hidden
look for hidden media also, based on role permission
Description
Get custom media fields
Parameters
apikey
Optional parameters
status
filterbyname
offset
limit
format
one of "xml" or "json"
Description
Upload a medium
Parameters
apikey
token
title
description
tags
categories
Ex: 5,8,9
source_url
Optional parameters
hidden
2, 1 or 0
accept_comment
1 or 0
meta_title
meta_description
meta_keywords
meta_author
meta_copyright
mediapermissions
Ex: 1,2,3
payment_withcosts
1 or 0
payment_prize
custom_preview
1 or 0
preview_url
gm_location
gm_longitude
gm_latitude
gm_zoom
priority_transcode
1 or 0
thumbnail
uploaded
created
startdate
Valid date formats: m/d/Y H:i:s B, Y-m-dTH:i:s B+P, Y-m-dTH:i:s BZ (dates must be URL encoded)
enddate
Valid dates: m/d/Y H:i:s B, Y-m-dTH:i:s B+P, Y-m-dTH:i:s BZ (dates must be URL encoded)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
uid
Description
Import media via xml files form specified directory
Parameters
apikey
importpath
Optional parameters
format
one of "xml" or "json"
Description
Add subtitle from specified file path
Parameters
apikey
token
mediumid
medium id or media key
subtitlefile
subtitlelanguage
ISO-639-1 language code
Optional parameters
format
one of "xml" or "json"
Description
Remove subtitle for specified media
Parameters
apikey
token
mediumid
medium id or media key
subtitlefile
subtitlelanguage
ISO-639-1 language code
Optional parameters
format
one of "xml" or "json"
Description
Remove subtitles for specified media
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Get ISO-639-1 language codes
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
Description
Get installed languages
Parameters
apikey
Optional parameters
enabled
true, false
format
one of "xml" or "json"
Description
Edit a medium
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
title
description
tags
categories
Ex: 5,8,9
thumbnail
hidden
2, 1 or 0
accept_comment
1 or 0
meta_title
meta_description
meta_keywords
meta_author
meta_copyright
mediapermissions
Ex: 1,2,3
payment_withcosts
1 or 0
payment_prize
custom_preview
1 or 0
preview_url
gm_location
gm_longitude
gm_latitude
gm_zoom
priority_transcode
1 or 0
uploaded
created
startdate
Valid date formats: m/d/Y H:i:s B, Y-m-dTH:i:s B+P, Y-m-dTH:i:s BZ (dates must be URL encoded)
enddate
Valid dates: m/d/Y H:i:s B, Y-m-dTH:i:s B+P, Y-m-dTH:i:s BZ (dates must be URL encoded)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
uid
source_url
Description
Get medium transcoding progress
Parameters
apikey
mediumid
medium id or media key
Description
Add medium count
Parameters
apikey
token
mediumid
medium id or media key
Description
Lock a media. Set status to illegal.
Parameters
apikey
mediumid
medium id or media key
token
Optional parameters
format
one of "xml" or "json"
Description
Unlock a media. Set status to legal.
Parameters
apikey
mediumid
medium id or media key
token
Optional parameters
format
one of "xml" or "json"
Description
Get medium picture
Parameters
apikey
type
medium, user, category, channel, group or livestream
key/id
Medium key or medium id
Optional parameters
noframework
Deliver image without framework
1 or 0
size
format
one of "xml" or "json"
Description
Delete a medium
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Report innapropriate medium
Parameters
apikey
token
mediumid
medium id or media key
reason
Optional parameters
format
one of "xml" or "json"
Description
Get all comments of a medium
Parameters
apikey
mediumid
medium id or media key
Optional parameters
token
offset
limit
format
one of "xml" or "json"
Description
Add comment to a medium
Parameters
apikey
token
mediumid
medium id or media key
comment
Optional parameters
format
one of "xml" or "json"
Description
Delete a comment of a medium
Parameters
apikey
token
mediumid
medium id or media key
commentid
Optional parameters
format
one of "xml" or "json"
Description
Add rating to a specific medium
Parameters
apikey
token
mediumid
medium id or media key
rating
1..5
Optional parameters
format
one of "xml" or "json"
Description
Add like to a specific medium
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Delete like to a specific medium
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Add a medium to user favorite
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Remove a medium from user's favorite
Parameters
apikey
token
mediumid
medium id or media key
Optional parameters
format
one of "xml" or "json"
Description
Get a specific playlist using ID
Parameters
apikey
playlistid
Optional parameters
format
one of "xml" or "json"
Description
Get all user playlists
Parameters
apikey
userid
Optional parameters
format
one of "xml" or "json"
Description
Create playlist
Parameters
apikey
token
playlisttitle
userid
Optional parameters
hidden
0 - public, 1 - hidden, 2 - private
format
one of "xml" or "json"
Description
Edit playlist title
Parameters
apikey
token
playlistid
title
Optional parameters
format
one of "xml" or "json"
Description
Delete playlist
Parameters
apikey
token
playlistid
Optional parameters
format
one of "xml" or "json"
Description
Add medium to playlist
Parameters
apikey
token
playlistid
mediumid
Optional parameters
format
one of "xml" or "json"
Description
Delete medium from playlist
Parameters
apikey
token
playlistid
mediumid
Optional parameters
format
one of "xml" or "json"
Description
Edit livestream
Parameters
apikey
token
livestreamid
Optional parameters
title
description
tags
categories
picture
picture_menu
picture_cover
picture_placeholder
hidden
1 or 0
verify
1 or 0
livestream_permissions
Ex: 1,2,3
stream_rtmp
stream_hls
stream_rtp
stream_hds
stream_silverlight
format
one of "xml" or "json"
Description
Get all livestreams
Parameters
apikey
Optional parameters
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Get a specific livestream using ID
Parameters
apikey
livestreamid
Optional parameters
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Get all comments of a livestream
Parameters
apikey
livestreamid
Optional parameters
offset
limit
format
one of "xml" or "json"
Description
Add comment to a livestream
Parameters
apikey
token
livestreamid
comment
Optional parameters
format
one of "xml" or "json"
Description
Delete a comment of a livestream
Parameters
apikey
token
livestreamid
commentid
Optional parameters
format
one of "xml" or "json"
Description
Add rating to a specific livestream
Parameters
apikey
token
livestreamid
rating
1..5
Optional parameters
format
one of "xml" or "json"
Description
Add like to a specific livestream
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
Description
Delete like to a specific livestream
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
Description
Add a livestream to user favorite
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
Description
Remove a livestream from user's favorite
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
Description
Get all pages
Parameters
apikey
Optional parameters
filterbyname
offset
limit
language
ISO-639-1 code for page content
format
one of "xml" or "json"
Description
Get a specific page using ID
Parameters
apikey
pageid
Optional parameters
language
ISO-639-1 code for page content
format
one of "xml" or "json"
Description
Login a specific user over JSON Web Token
Parameters
webtoken
JSON Web Token
Optional parameters
format
one of "xml" or "json"
Description
Get all users
Parameters
apikey
Optional parameters
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
Description
Get a specific user using ID
Parameters
apikey
userid
Optional parameters
roles
true, false
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
Description
Get custom user fields
Parameters
apikey
Optional parameters
status
filterbyname
offset
limit
format
one of "xml" or "json"
Description
Login a specific user
Parameters
apikey
username
Optional parameters
format
one of "xml" or "json"
password
token
Description
Logout a specific user
Parameters
apikey
token
Optional parameters
format
one of "xml" or "json"
Description
Register a new user
Parameters
apikey
username
email
password
Optional parameters
avatar
Url
coverpicture
Url
firstname
lastname
gender
male or female
city
country
birthday
yyyy-mm-dd
aboutme
credits
format
one of "xml" or "json"
Description
Change basic user data.
Parameters
apikey
token
userid
Optional parameters
username
password
email
avatar
Url
coverpicture
Url
firstname
lastname
gender
male or female
city
country
birthday
yyyy-mm-dd
aboutme
credits
format
one of "xml" or "json"
Description
Reset password of a registered user. New password will be sent to the registered email address of the user.
Parameters
apikey
token
old_password
new_password
Optional parameters
userid
format
one of "xml" or "json"
Description
Delete a user.
Parameters
apikey
token
userid
Optional parameters
format
one of "xml" or "json"
Description
Purge a user.
Parameters
apikey
token
userid
Optional parameters
format
one of "xml" or "json"
Description
Report innapropiate user
Parameters
apikey
token
userid
reason
Optional parameters
format
one of "xml" or "json"
Description
Get a user's comments on its profile page
Parameters
apikey
userid
Optional parameters
format
one of "xml" or "json"
Description
Add a user comment
Parameters
apikey
token
userid
comment
Optional parameters
format
one of "xml" or "json"
Description
Delete a user comment
Parameters
apikey
token
commentid
Optional parameters
format
one of "xml" or "json"
Description
Get user's favorite media
Parameters
apikey
userid
Optional parameters
token
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
Get user's media
Parameters
apikey
userid
Optional parameters
token
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
orderby
one of "created", "uploaded", "updated" or "name"
sortdirection
one of "asc" or "desc"
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
Get user's friends
Parameters
apikey
userid
Optional parameters
offset
limit
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
Get user's groups
Parameters
apikey
userid
Optional parameters
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
Get user's channels
Parameters
apikey
userid
Optional parameters
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for category names
format
one of "xml" or "json"
Description
get user roles
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
Description
add role to user
Parameters
apikey
token
userid
roleid
Optional parameters
format
one of "xml" or "json"
Description
remove role from user
Parameters
apikey
token
userid
roleid
Optional parameters
format
one of "xml" or "json"
Description
get iframe for media
Parameters
apikey
url
medium url
Optional parameters
t
start time of iframe (t=x)
width
height
autoplay
true or false
related
true or false
loadonclick
true or false
responsive
true or false
format
one of "xml" or "json"
Description
Get all groups
Parameters
apikey
Optional parameters
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
Description
Get a specific group using ID
Parameters
apikey
groupid
Optional parameters
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
Description
Get all user from a specified group
Parameters
apikey
groupid
Optional parameters
offset
limit
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
Description
Get all media from a specified group
Parameters
apikey
groupid
Optional parameters
token
filterbyname
filterbytype
id of the media type
filterbycategory
id of the category
filterbyfilter
one of "comments" "toprated" "hottest" "featured" or "newest"
orderby
one of "created", "uploaded", "updated" or "name"
sortdirection
one of "asc" or "desc"
offset
limit
thumbsize
width x height (ex. 210x108)
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
Description
Search
Parameters
apikey
keyword
Optional parameters
token
hidden
true, false
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
mediapermissions
Ex: 1,2,3
Description
Extended search
Parameters
apikey
title
Optional parameters
token
description
tags
searchrange
one of "all", "video", "audio", "document", "photo" or "user" (Default: "all")
groups
channels
categories
hidden
true, false
private
true, false
duration
uploaded
created
language
ISO-639-1 code for media category names
format
one of "xml" or "json"
mediapermissions
Ex: 1,2,3
userid
owner
created_min
upload date or later
Valid date format: Y-m-d H:i:s
created_max
upload date or earlier
Valid date format: Y-m-d H:i:s
duration_min
duration or longer
duration_max
duration or shorter
views_min
minimum views
views_max
maximum views
Description
Get all media chapters
Parameters
apikey
mediumid
Optional parameters
languageCode
ISO-639-1 code
format
one of "xml" or "json"
Description
Add media chapter
Parameters
apikey
token
mediumid
title
time
in seconds
languageCode
ISO-639-1 code
Optional parameters
format
one of "xml" or "json"
Description
Edit media chapter
Parameters
apikey
token
mediumid
chapterid
Optional parameters
title
time
in seconds
languageCode
ISO-639-1 code
format
one of "xml" or "json"

Data types and structures

Structure Category {
      Integer cid;
      Integer parent;
      String culture;
      String name;
      String description;
      Integer categorytype;
      Integer status;
      String picture;
      Integer weight;
      DateTime created_at;
      DateTime updated_at;
    }  
Structure Channel {
      Integer chid;
      Integer status;
      Integer uid;
      String username;
      String picture;
      String picture_menu;
      String culture;
      String title;
      String description;
      DateTime created_at;
      DateTime updated_at;
    }  
Structure Media {
      Integer mid;
      Integer uid;
      String username;
      String mediakey;
      Integer mediatype;
      Boolean first;
      Boolean hidden;
      Integer status;
      Boolean featured;
      String culture;
      String[] properties;
      String title;
      String description;
      Integer duration;
      String medium;
      String thumbnail;
      String source;
              DateTime startdate;
      DateTime enddate;
          String meta_title;
      String meta_description;
      String meta_keywords;
      String meta_author;
      String meta_copyright;
      String conversion_notice;
      Real sum_rating;
      Integer count_views;
      Integer count_rating;
      Integer count_favorites;
      Integer count_comments;
      Integer count_flags;
      DateTime created_at;
      DateTime updated_at;
      DateTime converted_at;
      Category[] categories;
      Tag[] tags;
      String embed_code;
    }  
Structure Page {
      Integer wid;
      Integer status;
      String culture;
      String title;
      String description;
      String description;
      DateTime created_at;
      DateTime updated_at;
    }  
Structure User {
      Integer uid;
      Integer status;
      String username;
      String email;
      String avatar;
      String cover;
          String firstname;
          String lastname;
          String city;
          String country;
          DateTime birthday;
          Integer gender;
          String about;
          DateTime last_login_at;
      DateTime last_access_at;
      DateTime created_at;
      DateTime updated_at;
    }  
Structure Tag {
      Integer tid;
      String culture;
      String name;
      DateTime created_at;
      DateTime updated_at;
    }
Group
Structure Group {
      Integer gid;
      Integer uid;
      String username;
      String groupkey;
      Boolean hidden;
      Integer status;
      Boolean featured;
      String culture;
      String title;
      String description;
      String picture;
      String cover;
      Integer weight;
      DateTime created_at;
      DateTime updated_at;
    }

Video platform & player solutions powered by VIMP © 2010-2024