| Version 2 (modified by guest, 16 years ago) (diff) |
|---|
Introduction to OSDb
Sections
This page is aimed at developers who'd like to implement the OSDb protocol and functionality into their own applications. Here'll you'll find the API specifications for all available functions along with structure definitions and useful hints.
Our API is based on XML-RPC so you might want to take a look at its specifications and implementations.
Our API supports many methods so there should be no problem to code some nice client applications.
If you're missing any method feel free to contact us on the forum to discuss possibilities.
Short Wikipedia excerpt about XML-RPC: XML-RPC is a very simple protocol, defining only a handful of data types and commands and the entire description can be printed on two pages of paper. This is in stark contrast to most RPC systems, where the standards documents often run into the hundreds of pages and require considerable software support in order to be used.
Instructions
- Read this first
- All development testing should be pointed to: http://dev.opensubtitles.org/xml-rpc (currently offline, so use main server)
- Main/Production? server XML-RPC URL: http://www.opensubtitles.org/xml-rpc
- Before developing let us know and we will assign/agree on useragent code for your application.
- For languages codes, check ISO639, use pb/pob for Portuguese (Brazil) - Download OS languages table dump
- For gzip compression use function which adds no header to output, for PHP it's: gzcompress. For decompression use gzdecompress.
XML-RPC methods
Session handling
- LogIn - login user and start session
struct LogIn(string $username, string $password, string $language, string $useragent)
- LogOut - logout user and end session
struct LogOut(string $token)
- NoOperation - keep-alive user's session, verify token/session validity
struct NoOperation(string $token)
Search and download
- SearchSubtitles - search for subtitles using video hashes or IMDb ID
struct SearchSubtitles(string $token, array(struct('sublanguageid' => string $sublanguageid, 'moviehash' => string $moviehash, 'moviebytesize' => int $moviesize, 'imdbid' => string $imdbid ), struct(...)))
- SearchToMail - search for subtitles, send result to e-mail address
- DownloadSubtitles - download given subtitle files
struct DownloadSubtitles(string $token, array($IDSubtitleFile, $IDSubtitleFile,...) $data)
Upload
- TryUploadSubtitles - check subtitles before uploading
- UploadSubtitles - upload given subtitle
Movies
- SearchMoviesOnIMDB -
- GetIMDBMovieDetails - get movie details fro given IMDb ID
- InsertMovie - insert a new movie
Reporting and rating
- ServerInfo - get basic server information and statistics
- ReportMovieHash - report wrong
- SubtitlesVote - rate subtitles
User interface
- GetSubLanguages - get support subtitle languages
- DetectLanguage - detect language for given text
- GetAvailableTranslations - get list of available translations for a client application
- GetTranslation - get given language translation file for a client application
- AutoUpdate - check for latest version of a client application
Checking
Credits
- 2ge - writer of OSDb XML-RPC server-side implementation
- eduo - supplier of various example inputs/outputs
- all other contributors
