GetSessionID

Use this call to retrieve a SessionID, which is a unique identifier that you use for authentication during the token-creation process. You must have a valid SessionID value in order to make a FetchToken request.

See Getting a Token via FetchToken for a step-by-step description of retrieving and using a SessionID.

Unlike other Trading API calls, GetSessionID requires your application keys (App ID, Dev ID, and Cert ID), as well as an RuName value. Include the application keys in the SOAP header for SOAP requests, or in the HTTP header for XML requests. Register your RuName with eBay. For details on RuNames, see Setting Up an Application to Receive Tokens.

Once you obtain the SessionID, you can use it to construct the URL that sends a user to the eBay consent flow. Also, use the SessionID value when you retrieve the user token with FetchToken.

You can test GetSessionID in the Sandbox. You'll need to create at least one test user to do that. For information about creating and using test users, see Testing in the SandBox. Use the following URL for the sign-in and consent page for the Sandbox environment:

  https://signin.sandbox.ebay.com/ws/eBayISAPI.dll?SignIn&runame=MyRuName&SessID=MyURLEncodedSessionID

Note that in the sign-in URL, the value of the session ID must be URL-encoded.

See:
    Working with token/authentication calls
    Setting Up the Application to Receive Tokens

See also the reference documentation for these calls:

• ConfirmIdentity - Returns the ID of a user who has gone through an application's consent flow process for obtaining an authorization token.
• FetchToken - Retrieves an authentication token for a user.
• GetTokenStatus - This call is used to get the current status of a user token.
• RevokeToken - Revokes a token before it would otherwise expire.

Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetSessionIDRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <RuName> string </RuName>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSessionIDRequest>

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetSessionIDResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <SessionID> string </SessionID>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetSessionIDResponse>

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Returns a SessionID needed for fetching a token for a user.

Description

In this call, the authentication values for App ID, Dev ID, and Cert ID are supplied in the X-EBAY-API-APP-NAME, X-EBAY-API-DEV-NAME, and X-EBAY-API-CERT-NAME HTTP headers, respectively. The response contains the SessionID value, which you can use in the FetchToken call to get a user authentication token.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetSessionIDRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RuName>M**********e</RuName>
</GetSessionIDRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetSessionIDResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T22:22:25.494Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1123</Version>
  <Build>E1123_CORE_APISIGNIN_19059235_R1</Build>
  <SessionID>M*********D</SessionID>
</GetSessionIDResponse>

Change History