(SQL Server) Get eBay Application Token

This example shows how to request an eBay Application token.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- See the Ebay documentation about Access token types
    -- Also see the Ebay documentation about client credentials grant flow

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- If using the sandbox, the target endpoint will be:
    -- POST https://api.sandbox.ebay.com/identity/v1/oauth2/token

    -- If using the production (live) system, the target endpoint will be:
    -- POST https://api.ebay.com/identity/v1/oauth2/token

    -- The eBay client_id and client_secret needs to be sent
    -- in a Basic Authorization  request header, which has this format:
    -- Authorization: Basic <B64_encoded_oauth_credentials>

    -- Chilkat takes care of it.  You only need to set the Login = client_id,
    -- and password = client_secret, and indicate you want "Basic" HTTP Authorization.
    EXEC sp_OASetProperty @http, 'Login', 'EBAY_CLIENT_ID'
    EXEC sp_OASetProperty @http, 'Password', 'EBAY_CLIENT_SECRET'
    EXEC sp_OASetProperty @http, 'BasicAuth', 1

    -- Let's do the following POST:

    --   HTTP method:   POST
    --   URL (Sandbox): https://api.sandbox.ebay.com/identity/v1/oauth2/token
    -- 
    --   HTTP headers:
    --     Content-Type = application/x-www-form-urlencoded
    --     Authorization = Basic <B64-encoded-oauth-credentials>
    -- 
    --   Request body (wrapped for readability):
    --     grant_type=client_credentials&
    --     redirect_uri=<RuName-value>&
    --     scope=<SPACE separated list of scopes>
    -- 

    -- Create an HttpRequest object to hold the request params.
    DECLARE @req int
    -- Use "Chilkat_9_5_0.HttpRequest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.HttpRequest', @req OUT

    EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
    EXEC sp_OAMethod @req, 'AddParam', NULL, 'grant_type', 'client_credentials'

    -- The scope query param indicates the access to be provided by the token.
    -- Multiple scopes can be specified by separating each with a SPACE char.
    -- See the Ebay OAuth scopes documentation

    EXEC sp_OAMethod @req, 'AddParam', NULL, 'scope', 'https://api.ebay.com/oauth/api_scope'

    -- (The PostUrlEncoded method automatically sets the Content-Type header equal to "application/x-www-form-urlencoded")
    DECLARE @endPoint nvarchar(4000)
    SELECT @endPoint = 'https://api.sandbox.ebay.com/identity/v1/oauth2/token'
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostUrlEncoded', @resp OUT, @endPoint, @req
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        RETURN
      END

    -- The response is JSON..
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    DECLARE @success int
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    -- If the response status code is not 200, then it failed.

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- We successfully retrieved an eBay access token.
    -- The actual access token string can be parsed from the JSON like this:
    DECLARE @accessToken nvarchar(4000)
    EXEC sp_OAMethod @json, 'StringOf', @accessToken OUT, 'access_token'

    -- This application token is only valid for 7200 seconds (2 hours).  We'll want to refresh
    -- it before it expires.  (There is an online example for that..)
    -- For now, let's save the JSON to a file for our application to use.

    -- But before doing that, let's add to the JSON an expiration timestamp
    -- so we know when to refresh the token.
    DECLARE @dtExpire int
    -- Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.CkDateTime', @dtExpire OUT

    EXEC sp_OAMethod @dtExpire, 'SetFromCurrentSystemTime', @success OUT
    EXEC sp_OAMethod @json, 'IntOf', @iTmp0 OUT, 'expires_in'
    EXEC sp_OAMethod @dtExpire, 'AddSeconds', @success OUT, @iTmp0
    EXEC sp_OAMethod @dtExpire, 'GetAsTimestamp', @sTmp0 OUT, 0
    EXEC sp_OAMethod @json, 'AppendString', @success OUT, 'expire_time', @sTmp0

    -- Persist the JSON to a file.
    DECLARE @fac int
    -- Use "Chilkat_9_5_0.FileAccess" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.FileAccess', @fac OUT

    DECLARE @success int
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @fac, 'WriteEntireTextFile', @success OUT, 'qa_data/tokens/ebay.json', @sTmp0, 'utf-8', 0
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @fac, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed to save eBay Application token to file.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @dtExpire
        EXEC @hr = sp_OADestroy @fac
        RETURN
      END

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    PRINT 'Success.'

    -- The output of this example is:

    -- 	{ 
    -- 	  "access_token": "v^1.1#i^1#p^1#I^3#r^0# ... Ajp1BQhJDgAA",
    -- 	  "token_type": "Application Access Token",
    -- 	  "expires_in": 7200,
    -- 	  "refresh_token": "N/A",
    -- 	  "expire_time": "2017-04-16T14:44:20Z"
    -- 	}
    -- 
    -- 	Success.
    -- 

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @dtExpire
    EXEC @hr = sp_OADestroy @fac


END
GO