Changes between Version 81 and Version 82 of XMLRPC

Timestamp:

May 11, 2015, 6:37:51 AM (10 years ago)

Author:

os

Comment:

--

XMLRPC

@@ -10 +10 @@
 
 = Instructions =
- * [wiki:DevReadFirst Read this first]
- * before using this XML-RPC is vital to have implementation for [wiki:HashSourceCodes OS HASH]
- * '''API server domain changed''': XML-RPC requests send to '''http://api.opensubtitles.org/xml-rpc'''
- * From 21.4.2015 we support HTTPS for LogIn() if you need it - you can use '''https://api.opensubtitles.org:443/xml-rpc''', for other methods use standard http to save some resources...
- * Before developing let us know, we assign useragent to you, empty useragent or unregistered UA will not work.
+ * [wiki:DevReadFirst Read this first] - Before developing let us know, we assign useragent to you, empty useragent or unregistered UA will not work.
+ * before using this XML-RPC is required to have implementation for [wiki:HashSourceCodes OS HASH]
+ * XML-RPC requests send to '''http://api.opensubtitles.org/xml-rpc''',  you may be interested in more verbose version of [wiki:XmlRpcIntro XML-RPC methods with examples]
+ * we start support HTTPS, if you need it - you can use '''https://api.opensubtitles.org:443/xml-rpc'''
  * 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]
  * IMDB ID is meant to be NUMBER from link of IMDB movie. Example: http://www.imdb.com/title/tt0133093/ - IMDB ID is '0133093' (removing trailing zero is also OK).
@@ -21 +20 @@
  * Handle properly HTTP status codes, sometimes you might get 5xx
  * if you get '''407 Download limit reached''', do not use persistent connections (HTTP keep-alive) and don't download more than 200 subtitles per 24 hour per IP/User. If user wants more, he can [http://www.opensubtitles.org/en/support#vip Donate]
- * you may be interested in more verbose version of [wiki:XmlRpcIntro XML-RPC methods with examples]
  * if you want search uploads by useragent, use this link: http://www.opensubtitles.org/search/sublanguageid-all/useragent-$UserAgent
  * for testing XML-RPC without programming, follow these [wiki:XML-RPC-debugger instructions]
  * please support '''GZIP compression for XML-RPC''' (in your HTTP request should be Accept-Encoding: gzip), it can save around [http://forum.opensubtitles.org/viewtopic.php?f=8&t=14246&p=27911 97.5% of bandwidth], so it is faster, it is better.
  * for '''XML-RPC and HTTP''' request use registered USERAGENT in HTTP HEADERs, invalid UA could result for blocking users.
+ * You can specify preferred language for response also by sending HTTP HEADER "Accept-Language"
  * when downloading subtitles using standard HTTP we added HTTP RESPONSE HEADER: Download-Quota: %d, where %d is number how many subtitles can user still download.
  * it is '''REQUIRED''' that your implementation supports '''!LogIn() with user credentials''' (manually input user and password), because there are quite a lot of IPs, which are proxy (some service providers NAT, Singapore, Iran and others), and there is download limit per IP, so those users will hit limit very soon and OS will be not usable for them. Also there is other important reasons why to support this (VIP membership and so on). Also '''NEVER''' put in your application registered username and password, it might be blocked.
 
+
 = Common errors =
 After reviewing database with movie-hashes, we found developers often make these errors
- * moviebytesize set to low integer, so overflow happens. Don't forget files can be more than 8GB big (8.589.934.592 bytes), so make sure you allocate right variable for moviebytesize!
+ * moviebytesize set to low integer, so overflow happens. Don't forget files can be more than 8GB big (8.589.934.592 bytes), so make sure you allocate right variable for moviebytesize (string is OK)!
  * moviehash in 99,999% can not be '0000000000000000' (we are ignoring them now, but it is error)
  * always pass all Method Parameters as string, because some unwanted conversion can occur. For example moviebytesize pass as string "4249049694" and NOT as int 4249049694.