Changes between Version 63 and Version 64 of WebRpc


Ignore:
Timestamp:
Jan 21, 2021, 6:31:44 PM (4 years ago)
Author:
davea
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WebRpc

    v63 v64  
    99and credit statistics web sites.
    1010
    11 BOINC's RPC mechanisms have the following conventions:
     11These RPCs have the following conventions:
    1212
    1313 * Each RPC is an HTTP GET transaction.
     
    6060
    6161 '''-209''': Attach failed. Perhaps due to invalid invitation code.
     62
     63The file boinc/html/inc/web_rpc_api.php has PHP interfaces for
     64a few of the RPCs (lookup_account, create_account, download_info).
     65
    6266----
    6367== Project configuration == #get_project_config
     
    773777    </application>
    774778</app_versions>
    775 
    776 }}}
    777 
     779}}}
     780
     781== Get info for auto-attach download button == #download
     782
     783This lets a "source" web site provide download buttons that
     784auto-attach to an account on a "target" BOINC project or account manager.
     785
     786 URL::
     787    project/download_software.php
     788 input::
     789    user_agent: user agent string passed by user's browser
     790    authenticator:: authenticator of user account
     791    caller_key:: a key supplied by the target project
     792 output::
     793    Error if account not found, or can't figure out user's platform,
     794    or the platform doesn't support auto-attach (only Mac and Win currently do).
     795    In that case show a link to the BOINC download page,
     796    https://boinc.berkeley.edu/download.php
     797
     798    Otherwise returns XML of the form
     799{{{
     800<?xml version="1.0" encoding="ISO-8859-1" ?>
     801<download_info>
     802   <project_id>X</project_id>
     803   <token>X</token>
     804   <user_id>X</user_id>
     805   <boinc>
     806      <filename>X</filename>
     807      <size_mb>X</size_mb>
     808      <boinc_version>X</boinc_version>
     809   </boinc>
     810   <boinc_vbox>
     811      <filename>X</filename>
     812      <size_mb>X</size_mb>
     813      <boinc_version>X</boinc_version>
     814      <vbox_version>X</vbox_version>
     815   </boinc_vbox>
     816</download_info>
     817}}}
     818This info is used to create buttons for downloading
     819auto-attach versions of the BOINC installer.
     820I.e. when the user downloads and installs,
     821they'll be attached to the given account.
     822The <boinc_vbox> element is present if there's a combined BOINC/Vbox installer for the platform.
     823
     824See web_rpc_api.inc for example usage in PHP.