Auth.getSession

Returns the session key bound to an auth_token, as returned by auth.createToken or in the callback_url. Should be called immediately after the user has logged in.

Parameters

Type Name Required Description
string api_key The application key associated with the calling application.
string sig An MD5 hash of the current request and your secret key, as described in the authentication guide.
string v This must be set to 1.0 to use this version of the API.
string format Desired response format. Either XML (default) or JSON.
string callback Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter.

Note that for desktop applications this method must be called at the https endpoint instead of the http endpoint, and its return value is slightly different (as noted below). Note also that this function does not require a session_key or call_id (although specifying a call_id will not cause any problems). The session key is storable for the duration of the session, and the uid is storable indefinitely.