Main Page

From Aviberry API

Aviberry API - Getting Started

Aviberry is designed to be easily integrated with online services or content management systems. You can power your app or website with our video conversion capabilities.

The same API is used for integration with Cloud Online Video Converter and Aviberry Video Server. Minor differences are described in methods documentation

Aviberry API calls can be executed by requests via HTTP GET and POST methods.

Base URL:

http://api_key:api_pass@api_server/api/version/protocol/method?param=value

• api_key и api_pass - API access credentials for your account. It can be regenerated on account page at any time.
• api_server - Aviberry server for receiving requests. It is aviberry.com by default. If you use your own server you will need to put its address here.
• version - API version (ex.: "v1.1.1"). It's recommended to always use the latest stable version.
• protocol - used data-interchange protocol: "json" or "xml".
• method - method name.
• param и value - name and value of parameter passed to a method. In API calls using GET methods all the parameter values should be coded according to standard.

For "json" protocol, the post body should be a JSON object, containing the method name and parameters, and for "xml" protocol the post body should be an XML-RPC request. JSON-RPC protocol support up to 2.0 inclusive

According to the protocol used for making a call, server will choose the response format.

All transfered string data should be UTF-8 encoded unless otherwise specified.

You can use external libraries for Aviberry API calls. For example:

• JSON-RPC for PHP
• XML-RPC for PHP

API versions

• API 1.0 - is not supported any more
• API 1.1 - Release Date: March, 2011
• API 1.1.1 - Release Date: November, 2011. Based on API 1.1, with minor changes to work with super-tasks. Recommended version.

Documentation

1. API 1.1 and API 1.1.1
   1. API Methods
      • startConversion
      • cancelConversion
      • deleteConversion
      • getConversion
      • getConversionCount
      • getConversions
      • getProgress
      • getTraffic
   2. Conversion statuses
   3. Formats and presets
      • Video Formats
        • HTTP Live Streaming
        • 3GPP (MPEG-4, H.263, H.264)
        • 3GPP2 (MPEG-4, H.263, H.264)
        • AVI (Xvid MPEG-4)
        • FLV (H.263, H.264)
        • MP4 (MPEG-4, H.263, H.264)
        • MPEG-1,2 (MPEG1, MPEG2)
        • WebM/VP8
        • WMV
      • Audio Formats
        • MP3
        • WAV
        • WMA
   4. Additional Features
      • GenerateFLV - Changing MPEG-4 container to FLV without reencoding
      • SkipIfFileMatchesPreset - Skipping conversion if input file parameters are the same as conversion parameters
      • PreviewOffset - Setting snapshot shift
      • GetMediaInfo - Getting information about the converted file
   5. Transformations
      • Cut
      • Split
      • Crop
      • Rotate
      • Watermark
      • Video adjustment
      • Converting to 3D
   6. About encodings
   7. Error messages
   8. API Sample Scripts
2. API 1.0 - is not supported any more

Still have a question?