Changes between Version 120 and Version 121 of XMLRPC

Timestamp:

Nov 22, 2017, 12:52:28 PM (6 years ago)

Author:

os

Comment:

--

XMLRPC

@@ -12 +12 @@
  * [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]
- * we start support HTTPS, if you need it - you can use '''https://api.opensubtitles.org:443/xml-rpc'''
- * XML-RPC requests send to '''http://api.opensubtitles.org:80/xml-rpc''',  you may be interested in more verbose version of [wiki:XmlRpcIntro XML-RPC methods with examples]
+ * we recommend to use HTTPS - you can use '''https://api.opensubtitles.org:443/xml-rpc'''
+ * XML-RPC requests send to '''https://api.opensubtitles.org/xml-rpc''',  you may be interested in more verbose version of [wiki:XmlRpcIntro XML-RPC methods with examples]
  * API Request limit: '''40 HTTP requests per 10 seconds per IP address''', read here more https://forum.opensubtitles.org/viewtopic.php?f=8&t=16072
- * Check HTTP Response header 'X-RateLimit-Remaining' for http requests remaining per given period.
+ * Check HTTP Response header '!X-RateLimit-Remaining' for http requests remaining per given period.
  * 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 leading 0 is also OK).
@@ -29 +29 @@
  * 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.
+ * VIP Users should communicate with VIP API server, please read more in !LogIn()
  * if you are sending subtitle contents for analysis (example !DetectLanguage()), please always send WHOLE subtitle file, because results of analysis can be different if you sent just portion.
  * when downloading subtitles from server, you can set up 3-5 retries, 1-5 seconds delay. Don't abuse server with unlimited download retries and small (or no) delay
@@ -93 +94 @@
 Important: for security improvement, you can use HTTPS and/or send $password as MD5($password) hash.
 
-Note: don't send any cookies using XML-RPC, specially cookie named "PHPSESSID=" can cause unpredictable behaviour while Loggin In.
+Note: don't send any cookies using XML-RPC communication.
+If VIP user is logged, in HTTP response headers and XML-RPC [data] field is returned:
+Content-Location: https://vip-api.opensubtitles.org.local/xml-rpc - your application should change host to continue communicating with VIP API server. This API server is special for VIP users, it is more stable and faster.
 
 Example output:
@@ -108 +111 @@
             [DownloadCnt] => 1215
             [UserWebLanguage] => en
+            [Content-Location] => https://vip-api.opensubtitles.org.local/xml-rpc
         )
     [seconds] => 0.496
@@ -117 +121 @@
  * status => status code
  * seconds => how long time takes this process on server
+
 
 ----