NAME

eBay::API::XML::Call::FetchToken::FetchTokenRequestType

DESCRIPTION

Retrieves user token. The call can be used to get a token only after a user, at an eBay sign-in page, gives consent for the token to be generated. After token retrieval, the token can be used to authenticate other calls made on behalf of the user.

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::FetchToken::FetchTokenRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

setIncludeRESTToken()

Specified if you want to retrieve a REST token for a user.

  RequiredInput: No
#    Argument: 'xs:boolean'

isIncludeRESTToken()

# Returns: 'xs:boolean'

setSecretID()

A value that is associated with the token retrieval request. SecretID is defined by the application, and is passed in redirect URL to the eBay signin page. eBay recommends using a UUID for the secret ID value. You must also set Username (part of the RequesterCredentials) for the particular user of interest. SecretID and Username are not required if SessionID is present.

  RequiredInput: No
#    Argument: 'xs:string'

getSecretID()

# Returns: 'xs:string'

setSessionID()

A value that is associated with the token retrieval request. The session ID is generated by eBay by the application making GetSessionID call, and is passed in redirect URL to the eBay signin page. The advantage of using SessionID is that it does not require UserID as part of the FetchToken request. SessionID is not required if SecretID is present.

  RequiredInput: No
#    Argument: 'xs:string'

getSessionID()

# Returns: 'xs:string'