F.A.Q (Frequently Asked Questions)


Your answer about Kewego's APIs might be there.
Just take a look at it. It's a good way to start understanding our APIs

Table of Contents:

General questions:

What can I do with the APIs / What is it used for?

  • The APIs allows to get acces to a lot of usefull functions to develop a full video website or to add easily videos in your website, based on the Kewego product.
  • You can do almost everything with the APIs. We also are constantly adding some new features to help you get the best result as possible.

What do I need to use the APIs?

  • If you know how to code (PHP, ASP, JSP, Java, AS...), then you can use our APIs!
  • You will need first a developer account (registration on this site).
  • Then ask for your Application Key and get started!

What languages are supported by the APIs?

  • APIs are webservices, therefore any language can use them.
  • You just call an http URL with parameters and you receive the corresponding XML response.

Where can I find help?

  • You will find all the documentation on this site, in the documentation section.
  • The forum is also there if you need some particular support.
  • Use the sandbox to test the functions you need with real parameters before using them.
  • You might also use the code samples to see examples of methods to use our APIs in various programming languages.

Application Key & appToken

What is an Application Key?

  • This is a unique and personnal key (associated to a developer account).
  • It identifies the product you are interacting with.
  • You can use one appKey per application you code.

Should I use a free or unlimited appKey?

  • Any registered developper can get a free key, which can be used to access content on the myKewego network of video sites.
  • If you are a Kewego customer, you should use an unlimited application Key, which will allow you to get access to the contents of your own product.

What is the difference between free and unlimited AppKeys?

  • Free are subject to limitations (bandwith, video downloads, availables functionalities...)
  • Free work on mykewego.* only.
  • Unlimited have no restriction.
  • Unlimited does work on your own product.
  • Basically if you are customer of Kewego, you should use an unlimited key. Then, all the functions that you will use will return results from your product and you will be able to build easily an entire video site with all the benefits of the Kewego API functions

Now that I have my appKey, what's next?

  • This appKey is confidential. Keep it safe and don't disclose it. It is required to use the API.
  • Thus, in order to hide your appKey from the public, you need first to generate an appToken (temporary token) with the function app/getToken. All the documentation is available in the documentation section of this site.

How sould I use the Apptoken?

  • An appToken has a validity of several hours. Thus, it can be saved into session to avoid asking for a new appToken each time you call to the API.
  • It can also be saved into a cookie. Then, if a used token is not valid, the kewego API server will send an error that you can catch and then ask for a new appToken.

Players

How can I play a video in my web site?

What types of player are provided by kewego?

    Kewego provides two players :
  • The Standard player : full of fonctionalities and modules, custumizable if your are customer. See More about Kewego standard player.
  • The Fast player : basic simple player, easy customization. See More about Kewego Fast player.

How do the playerkey and skinkey work?

  • The playerKey identifies the product you are interacting with. It is essential to set your own playerkey in the embed code of the player that you use in your pages, otherwise the video may not be played corectly (broadcasting rights) and you won't be able to get statistics for instance.
  • The skinKey identifies the customized skin of your player. This key is not compulsory, by default standard kewego skin will be used.

Can I change the color and design of my player?

  • It is posible to change the color and design of your player. If you are using the standard kewego player, this should be defined with your project manager.
  • If you are using the fast player, colors can be changed directly in the embed code, using flashvars.

Can I get various skinkeys with different designs?

  • No, for now, only one skin is available by product.

How does the channel player work?

  • The channel player is a version of the kewego standard player that can play a set of videos (channel).
  • The unique channel identifier (csig) must be used in the embed code, instead of the videos identifier (sig).

I want to play a video in a chosen encoding mode, is that posible?

  • Yes, with the standard player, you can set a specific flashvar to get the video in the right format. Please see our tutorial about standard player.
  • If you use your own player, notice that the format can also be specified in the API call.

Search

How does the search work?

  • Kewego uses a specific indexer to propose the best search results matching with searched keywords.
  • Results are returned according to the relevance of the keywords, the title, the categories and description of the video matching with the search.
  • Lots of functions like gethomepage, getlatestvideos, gettopvideos and getrelatedvideos are available. Please check the search package and choose the function that you need!

I want specific results matching with keywords, but only want to get my own videos in the results. Is that possible?

  • Yes, it is posible to use the search function to get the specific videos from a user, using the sentence "user:username".
  • Indeed, you can make a "search in a search" combining this sentence and keywords

Can I search restricted/private videos?

  • The private and restricted videos can be found using the user/getVideos function, but the user needs to be connected (authToken must be definied in the call)
  • This function returns the list of all the videos from the user. Thus, searching a specific private video matching with keywords is not yet available.

Can I get all the videos of my video platform?

  • No, if you have a "pro" account, you can get the list of your own videos (using user/getVideos function). But results are limited to 1000.

Upload

What is the full upload process? What are the encoding formats?

  • A tutorial explains the full uploading and encoding process : read it.

What type of file can I upload? What are the accepted codecs?

Can I upload the video and associated datas separately?

  • Yes, datas can be send to kewego servers before uploading the file. Actually you can also upload a file before sending the datas.
  • Check the tutorial available on this site to understand upload process using API calls.

Can I upload the same video several times?

  • You can't upload the same video several times on the same account (file is checked, changing the name of the file won't work neither).
  • However, same video can be uploaded on different accounts.

What is the diference between a public and restricted/private video?

  • A public video will be return in the search results.
  • A restricted video won't appear in the search results. The only way to get the restricted videos is to call the user/getVideos function, beeing connected (authToken parameter must be set).

Can I change the thumbnails of my videos?

  • Yes, it is posible to change the thumbnails of the videos. The function uploadThumbnail is available in the Upload package.
  • Notice that a crop tool is available in the kewego console, to make a thumbnail from a picture of the video!