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

 
URL
api/version
Description
Get version information
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
 
URL
api/config
Description
Get config parameters
Parameters
apikey
name
comma-separated list of parameters
Optional parameters
token
format
one of "xml" or "json"
 
URL
api/getCategories
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"
 
URL
api/getCategory
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"
 
URL
api/getCategoryMedia
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"
 
URL
api/getChannels
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"
 
URL
api/getChannel
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"
 
URL
api/getChannelMedia
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"
 
URL
api/addMediumChannel
Description
Add a medium to provided channel
Parameters
apikey
token
mediumid
channelid
Optional parameters
format
one of "xml" or "json"
 
URL
api/removeMediumChannel
Description
Delete a medium from a channel
Parameters
apikey
token
mediumid
channelid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getMedia
Description
Get all medias
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"
offset
limit
thumbsize
width x height (ex. 210x108)
hidden
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"
 
URL
api/getMedium
Description
Get a specific media using ID
Parameters
apikey
mediumid
Optional parameters
token
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
 
URL
api/getCustomMediaFields
Description
Get custom media fields
Parameters
apikey
Optional parameters
status
filterbyname
offset
limit
format
one of "xml" or "json"
 
URL
api/uploadMedium
Description
Upload a medium
Parameters
apikey
token
title
description
tags
categories
Ex: 5,8,9
source_url
Optional parameters
hidden
2, 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
gm_location
gm_longitude
gm_latitude
gm_zoom
priority_transcode
1 or 0
thumbnail
uploaded
created
start_date

Date de publication de la video, photos ou document

end_date

Date finale de publication de la video, photos ou document

language
ISO-639-1 code for category names
format
one of "xml" or "json"
uid
 
URL
api/mediaimport
Description
Import media via xml files form specified directory
Parameters
apikey
importpath
Optional parameters
format
one of "xml" or "json"
 
URL
api/addSubtitle
Description
Add subtitle from specified file path
Parameters
apikey
token
mediumid
subtitlefile
subtitlelanguage
ISO-639-1 language code
Optional parameters
format
one of "xml" or "json"
 
URL
api/removeSubtitle
Description
Remove subtitle for specified media
Parameters
apikey
token
mediumid
subtitlefile
subtitlelanguage
ISO-639-1 language code
Optional parameters
format
one of "xml" or "json"
 
URL
api/removeSubtitles
Description
Remove subtitles for specified media
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getLanguages
Description
Get ISO-639-1 language codes
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
 
URL
api/editMedium
Description
Edit a medium
Parameters
apikey
token
mediumid
Optional parameters
title
description
tags
categories
Ex: 5,8,9
thumbnail
hidden
2, 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
gm_location
gm_longitude
gm_latitude
gm_zoom
priority_transcode
1 or 0
uploaded
created
start_date

Date de publication de la video, photos ou document

end_date

Date finale de publication de la video, photos ou document

language
ISO-639-1 code for category names
format
one of "xml" or "json"
uid
 
URL
api/lockMedium
Description
Lock a media. Set status to illegal.
Parameters
apikey
mediumid
token
Optional parameters
format
one of "xml" or "json"
 
URL
api/unlockMedium
Description
Unlock a media. Set status to legal.
Parameters
apikey
mediumid
token
Optional parameters
format
one of "xml" or "json"
 
URL
api/getPicture
Description
Get medium picture
Parameters
apikey
type
key/id
Medium key or medium id
Optional parameters
size
format
one of "xml" or "json"
 
URL
api/deleteMedium
Description
Delete a medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/reportMedium
Description
Report innapropriate medium
Parameters
apikey
token
mediumid
reason
Optional parameters
format
one of "xml" or "json"
 
URL
api/getMediumComments
Description
Get all comments of a medium
Parameters
apikey
mediumid
Optional parameters
token
offset
limit
format
one of "xml" or "json"
 
URL
api/addMediumComment
Description
Add comment to a medium
Parameters
apikey
token
mediumid
comment
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumComment
Description
Delete a comment of a medium
Parameters
apikey
token
mediumid
commentid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumRating
Description
Add rating to a specific medium
Parameters
apikey
token
mediumid
rating
1..5
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumLike
Description
Add like to a specific medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumLike
Description
Delete like to a specific medium
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addMediumFavorite
Description
Add a medium to user favorite
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteMediumFavorite
Description
Remove a medium from user's favorite
Parameters
apikey
token
mediumid
Optional parameters
format
one of "xml" or "json"
 
URL
api/editLivestream
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
stream_rtmp
stream_hls
stream_rtp
stream_hds
stream_silverlight
format
one of "xml" or "json"
 
URL
api/getLivestreams
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"
 
URL
api/getLivestream
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"
 
URL
api/getLivestreamComments
Description
Get all comments of a livestream
Parameters
apikey
livestreamid
Optional parameters
offset
limit
format
one of "xml" or "json"
 
URL
api/addLivestreamComment
Description
Add comment to a livestream
Parameters
apikey
token
livestreamid
comment
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteLivestreamComment
Description
Delete a comment of a livestream
Parameters
apikey
token
livestreamid
commentid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addLivestreamRating
Description
Add rating to a specific livestream
Parameters
apikey
token
livestreamid
rating
1..5
Optional parameters
format
one of "xml" or "json"
 
URL
api/addLivestreamLike
Description
Add like to a specific livestream
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteLivestreamLike
Description
Delete like to a specific livestream
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addLivestreamFavorite
Description
Add a livestream to user favorite
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteLivestreamFavorite
Description
Remove a livestream from user's favorite
Parameters
apikey
token
livestreamid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getPages
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"
 
URL
api/getPage
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"
 
URL
api/webTokenLogin
Description
Login a specific user over JSON Web Token
Parameters
webtoken
JSON Web Token
Optional parameters
format
one of "xml" or "json"
 
URL
api/getUsers
Description
Get all users
Parameters
apikey
Optional parameters
filterbyname
offset
limit
thumbsize
width x height (ex. 210x108)
format
one of "xml" or "json"
 
URL
api/getUser
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"
 
URL
api/getCustomUserFields
Description
Get custom user fields
Parameters
apikey
Optional parameters
status
filterbyname
offset
limit
format
one of "xml" or "json"
 
URL
api/loginUser
Description
Login a specific user
Parameters
apikey
username
Optional parameters
format
one of "xml" or "json"
password
token
 
URL
api/logoutUser
Description
Logout a specific user
Parameters
apikey
token
Optional parameters
format
one of "xml" or "json"
 
URL
api/registerUser
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
format
one of "xml" or "json"
 
URL
api/editUser
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
format
one of "xml" or "json"
 
URL
api/setNewUserPassword
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"
 
URL
api/deleteUser
Description
Delete a user.
Parameters
apikey
token
userid
Optional parameters
format
one of "xml" or "json"
 
URL
api/backend/purgeUser
Description
Purge a user.
Parameters
apikey
token
userid
Optional parameters
format
one of "xml" or "json"
 
URL
api/reportUser
Description
Report innapropiate user
Parameters
apikey
token
userid
reason
Optional parameters
format
one of "xml" or "json"
 
URL
api/getUserComments
Description
Get a user's comments on its profile page
Parameters
apikey
userid
Optional parameters
format
one of "xml" or "json"
 
URL
api/addUserComment
Description
Add a user comment
Parameters
apikey
token
userid
comment
Optional parameters
format
one of "xml" or "json"
 
URL
api/deleteUserComment
Description
Delete a user comment
Parameters
apikey
token
commentid
Optional parameters
format
one of "xml" or "json"
 
URL
api/getUserFavoriteMedia
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"
 
URL
api/getUserMedia
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"
 
URL
api/getUserFriends
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"
 
URL
api/getUserChannels
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"
 
URL
api/getUserRoles
Description
get user roles
Parameters
apikey
Optional parameters
format
one of "xml" or "json"
 
URL
api/addUserRole
Description
add role to user
Parameters
apikey
token
userid
roleid
Optional parameters
format
one of "xml" or "json"
 
URL
api/search
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
 
URL
api/extendedSearch
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

Data types and structures

Category
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;
}
Channel
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;
}
Media
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 start_date;
  DateTime end_date;
  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;
}
Page
Structure Page {
  Integer wid;
  Integer status;
  String culture;
  String title;
  String description;
  String description;
  DateTime created_at;
  DateTime updated_at;
}
User
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;
}
Tag
Structure Tag {
  Integer tid;
  String culture;
  String name;
  DateTime created_at;
  DateTime updated_at;
}