Changes between Version 1 and Version 2 of XmlRpcIntro


Ignore:
Timestamp:
Sep 26, 2008, 9:51:46 PM (16 years ago)
Author:
guest
Comment:

Session handling finished, working on search/download now [Majky]

Legend:

Unmodified
Added
Removed
Modified

  • XmlRpcIntro

    v1 v2  
    33[[PageOutline(2, Sections)]]
    44
    5 We decided use [http://www.xmlrpc.com/ XMLRPC]
    6 (see [http://www.xmlrpc.com/spec spec] and [http://www.xmlrpc.com/directory/1568/implementations implementations])
    7 as default API for [http://www.opensubtitles.org opensubtitles.org].
     5This page is aimed at developers who'd like to implement the OSDb protocol and functionality into their own applications.
     6Here'll you'll find the API specifications for all available functions along with structure definitions and useful hints.
    87
    9 Our API supports many methods so there should be no problems to code some nice client applications.
     8Our API is based on [http://www.xmlrpc.com/ XML-RPC] so you might want to take a look at its
     9[http://www.xmlrpc.com/spec specifications] and [http://www.xmlrpc.com/directory/1568/implementations implementations].
    1010
    11 [http://en.wikipedia.org/wiki/XML-RPC Wikipedia]:
     11Our API supports many methods so there should be no problem to code some nice client applications.
     12
     13If you're missing any method feel free to contact us on the [http://forum.opensubtitles.org/viewforum.php?f=8 forum] to discuss possibilities.
     14
     15[http://en.wikipedia.org/wiki/XML-RPC Short Wikipedia excerpt about XML-RPC]:
    1216XML-RPC is a very simple protocol, defining only a handful of data types and commands
    1317and the entire description can be printed on two pages of paper.
    … …  
    1923 * [wiki:DevReadFirst Read this first]
    2024 * All development testing should be pointed to: http://dev.opensubtitles.org/xml-rpc (currently offline, so use main server)
    21  * Main/Production server XMLRPC URL: http://www.opensubtitles.org/xml-rpc
     25 * Main/Production server XML-RPC URL: http://www.opensubtitles.org/xml-rpc
    2226 * Before developing let us know and we will assign/agree on useragent code for your application.
    2327 * For languages codes, check [http://en.wikipedia.org/wiki/List_of_ISO_639-2_codes ISO639], use '''pb/pob''' for Portuguese (Brazil) - [http://www.opensubtitles.org/addons/export_languages.php Download OS languages table dump]
    … …  
    2529
    2630
    27 = XMLRPC methods =
     31= XML-RPC methods =
    2832
    2933== Session handling ==
    3034  * [wiki:XmlRpcLogIn LogIn] - login user and start session
    31       '''struct !LogIn( string $username, string $password, string $language, string $useragent )'''
    32   * [wiki:XmlRpcLogOut LogOut] - logout user
     35      '''struct !LogIn(string $username, string $password, string $language, string $useragent)'''
     36  * [wiki:XmlRpcLogOut LogOut] - logout user and end session
     37      '''struct !LogOut(string $token)'''
    3338  * [wiki:XmlRpcNoOperation NoOperation] - keep-alive user's session, verify token/session validity
    34  
     39      '''struct !NoOperation(string $token)'''
     40
    3541
    3642== Search and download ==
    3743  * [wiki:XmlRpcSearchSubtitles SearchSubtitles] - search for subtitles using video hashes or IMDb ID
     44      '''struct !SearchSubtitles(string $token, array(struct('sublanguageid' => string $sublanguageid, 'moviehash' => string $moviehash, 'moviebytesize' => int $moviesize, 'imdbid' => string $imdbid ), struct(...)))'''
    3845  * [wiki:XmlRpcSearchToMail SearchToMail] - search for subtitles, send result to e-mail address
    3946  * [wiki:XmlRpcDownloadSubtitles DownloadSubtitles] - download given subtitle files
     47      '''struct !DownloadSubtitles(string $token, array($IDSubtitleFile, $IDSubtitleFile,...) $data)'''
    4048
    4149