Changes between Version 63 and Version 64 of WebRpc

Timestamp:

Jan 21, 2021, 6:31:44 PM (4 years ago)

Author:

davea

Comment:

--

WebRpc

@@ -9 +9 @@
 and credit statistics web sites.
 
-BOINC's RPC mechanisms have the following conventions:
+These RPCs have the following conventions:
 
  * Each RPC is an HTTP GET transaction.
@@ -60 +60 @@
 
  '''-209''': Attach failed. Perhaps due to invalid invitation code.
+
+The file boinc/html/inc/web_rpc_api.php has PHP interfaces for
+a few of the RPCs (lookup_account, create_account, download_info).
+
 ----
 == Project configuration == #get_project_config
@@ -773 +777 @@
     </application>
 </app_versions>
-
-}}}
-
+}}}
+
+== Get info for auto-attach download button == #download
+
+This lets a "source" web site provide download buttons that
+auto-attach to an account on a "target" BOINC project or account manager.
+
+ URL::
+    project/download_software.php
+ input::
+    user_agent: user agent string passed by user's browser
+    authenticator:: authenticator of user account
+    caller_key:: a key supplied by the target project
+ output::
+    Error if account not found, or can't figure out user's platform,
+    or the platform doesn't support auto-attach (only Mac and Win currently do).
+    In that case show a link to the BOINC download page,
+    https://boinc.berkeley.edu/download.php
+
+    Otherwise returns XML of the form
+{{{
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<download_info>
+   <project_id>X</project_id>
+   <token>X</token>
+   <user_id>X</user_id>
+   <boinc>
+      <filename>X</filename>
+      <size_mb>X</size_mb>
+      <boinc_version>X</boinc_version>
+   </boinc>
+   <boinc_vbox>
+      <filename>X</filename>
+      <size_mb>X</size_mb>
+      <boinc_version>X</boinc_version>
+      <vbox_version>X</vbox_version>
+   </boinc_vbox>
+</download_info>
+}}}
+This info is used to create buttons for downloading
+auto-attach versions of the BOINC installer.
+I.e. when the user downloads and installs,
+they'll be attached to the given account.
+The <boinc_vbox> element is present if there's a combined BOINC/Vbox installer for the platform.
+
+See web_rpc_api.inc for example usage in PHP.