Tradera Developer Program

PublicService

Documentation Version 3 > PublicService > FetchToken

FetchToken |WebMethod|

Returns a previously created authorization token for the specified user.

Parameters
  1. userId, The Id of the user
  2. secretKey, The secret key used when the token was created documentation
Returns

The authorization Token object

Code Example

This PHP example show how this method can be used to retrieve the token.

  1:
  2:
  3:
  4:
  5:
  6:
  7:
  8:
  9:
 10:
 11:
 12:
 13:
 14:
 15:
 16:
 17:
 18:
 19:
 20:
 21:
 22:
 23:
 24:
 25:
 26:
 27:
 28:
 29:
 30:
 31:
 32:
 33:
 34:
 35:
 36:

 try {
 	// Replace the following variables with your own key management
 	// $APPLICATION_KEY
 	// $APPLICATION_ID
 	// $USER_ID
 	// $SECRET_KEY - this is the same key (skey) used when logging on userr
 	$userId = $USER_ID;
 	$secretKey = $SECRET_KEY;
 	$appId = $APPLICATION_ID;
 	$appKey = $APPLICATION_KEY;

 	$publicServiceUrl = 'https://api.tradera.com/v3/PublicService.asmx';

 	$publicServiceUrlWithAuth = $publicServiceUrl
 					. '?appId=' . $appId
 					. '&appKey=' . $appKey;

 	$publicClient = new SoapClient(
 		$publicServiceUrl . '?WSDL',
 		array('location' => $publicServiceUrlWithAuth)
 	);

 	// Parameters for call to FetchToken
 	$fetchTokenParams = new StdClass();
 	$fetchTokenParams -> userId = $userId;
 	$fetchTokenParams -> secretKey = $secretKey;
 	// Make SOAP call
 	$fetchTokenResponse = $publicClient -> FetchToken($fetchTokenParams);

 	// Handle result
 	echo 'Token: ' . $fetchTokenResponse -> FetchTokenResult -> AuthToken . PHP_EOL
 	. 'Expires: ' . $fetchTokenResponse -> FetchTokenResult -> HardExpirationTime . PHP_EOL;
 }
 catch(SoapFault $soapFault) {
 	echo 'Error: ' . $soapFault->faultstring;
 }

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/PublicService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tradera.com/FetchToken"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap:Header>
  <soap:Body>
    <FetchToken xmlns="http://api.tradera.com">
      <userId>int</userId>
      <secretKey>string</secretKey>
    </FetchToken>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <FetchTokenResponse xmlns="http://api.tradera.com">
      <FetchTokenResult>
        <AuthToken>string</AuthToken>
        <HardExpirationTime>dateTime</HardExpirationTime>
      </FetchTokenResult>
    </FetchTokenResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /v3/PublicService.asmx HTTP/1.1
Host: api.tradera.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthenticationHeader xmlns="http://api.tradera.com">
      <AppId>int</AppId>
      <AppKey>string</AppKey>
    </AuthenticationHeader>
    <ConfigurationHeader xmlns="http://api.tradera.com">
      <Sandbox>int</Sandbox>
      <MaxResultAge>int</MaxResultAge>
    </ConfigurationHeader>
  </soap12:Header>
  <soap12:Body>
    <FetchToken xmlns="http://api.tradera.com">
      <userId>int</userId>
      <secretKey>string</secretKey>
    </FetchToken>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <FetchTokenResponse xmlns="http://api.tradera.com">
      <FetchTokenResult>
        <AuthToken>string</AuthToken>
        <HardExpirationTime>dateTime</HardExpirationTime>
      </FetchTokenResult>
    </FetchTokenResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /v3/PublicService.asmx/FetchToken?userId=string&secretKey=string HTTP/1.1
Host: api.tradera.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://api.tradera.com">
  <AuthToken>string</AuthToken>
  <HardExpirationTime>dateTime</HardExpirationTime>
</Token>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /v3/PublicService.asmx/FetchToken HTTP/1.1
Host: api.tradera.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

userId=string&secretKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Token xmlns="http://api.tradera.com">
  <AuthToken>string</AuthToken>
  <HardExpirationTime>dateTime</HardExpirationTime>
</Token>

XHTML CSS