This method checks to see if an existing user token is still valid.
The URL for this method accepts the following parameters:
|
appid
|
String value. Required.
The Application ID, which is a unique identifier, assigned by Truveo, for your application. To view your current Application ID or request a new one, please consult your My API Account page.
|
|
method
|
String value. Required.
The name of the method to invoke. In this case, the value of this argument should be set to 'truveo.users.checkToken'.
|
|
token
|
String value. Required.
The token which identifies the user to the Truveo
Video Search APIs. This token is obtained using the 'truveo.users.getToken' method after the user has successfully
signed in to their AOL or AIM account. See the authentication spec for more details.
|
|
sig
|
String value. Required.
The sig is a unique signature which is constructed using the
other parameters to this method along with the Shared Secret assigned to your API account. Details on
constructing this signature are provided in the authentication spec.
|
The XML response for this method can contain the following fields:
|
<Response>
|
The top-level field for the XML response.
|
|
<method>
|
Parent tag: <Response>
A string containing the name of the API method used to retrieve the response. In this case, this field would return the string 'truveo.users.checkToken'.
|
|
<Result>
|
Parent tag: <Response>
The container for the response code, response message and any other information returned in this response.
|
|
<token>
|
Parent tag: <Result>
The token which identifies the user to the Truveo Video Search APIs.
|
|
<code>
|
Parent tag: <Result>
An integer specifying a code number for the response. This code number will typically be 1 for success and 0 for failure.
|
|
<message>
|
Parent tag: <Result>
A string containing a text message describing the response.
|
A sample REST-style request for this method can be constructed as follows:
http://xml.truveo.com/apiv3
?appid=[myAppId]
&method=truveo.users.checkToken
&token=[userTokenValue]
&sig=[mySignature]
Example XML Response
A sample XML response for this method is listed in the text field below.
Errors
If execution of this method is not successful, the following error codes can be returned:
|
1
|
Invalid request: 'appid'
An application ID was not submitted with the request.
|
|
2
|
Invalid request: 'method'
A method was not submitted with the request.
|
|
107
|
Invalid request: 'token'
The token parameter was not submitted with the request.
|
|
105
|
Invalid request: 'sig'
The sig parameter was not submitted with the request.
|
|
12
|
Service Unavailable
Truveo Video Search API service unavailable.
|
|
13
|
Method not found.
The method you submitted with the request was not valid.
|
|
14
|
Access Denied: invalid appid.
The application ID submitted with the request is invalid.
|
|
15
|
Access Denied: appid over limit.
The application ID submitted with the request is over the daily request limit.
|
|
103
|
Signature does not match
The signature that was supplied is invalid. The user could not be authenticated.
|