auth.getSessionKey

XmlRpc Api > Authentication service > auth.getSessionKey

First call that has to be performed to submit a session. Gives in return the user id and the next session key to use to perform the different session services calls.

Signature:

XmlRpcStruct auth.getSessionKey(String email, String hash)

Call:

URL: https://xmlrpc.renderfarm.fi/auth

Method: POST only

Protocol: XmlRpc

Transport: HTTPS

Handler name: auth.getSessionKey

Parameters:

Expected parameters are:

  • String email: the email of the user
  • String hash: the hash corresponding to md5(password+lowercase(mail))

Exceptions:

The list of possible exceptions is :

CodeReason
600Parameters incorrect
601Authentication incorrect
602Password incorrect

 

Returns:

An associative array with the expected parameters :

  • userId: the id of the user to use for later calls
  • key: next session key to use

Sample response:

<?xml version="1.0" encoding="utf-16"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>userId</name>
                        <value>
                            <boolean>888</boolean>
                        </value>
                    </member>
                    <member>
                        <name>key</name>
                        <value>
                            <string>84329082983049283423094823</string>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>