Xbase++

REST OAuth1 with Params

See more REST Examples

Demonstrates how to use OAuth 1.0a "one legged" authentication with Woo Commerce, with URLs that use query parameters. For example: /orders?status=processing Xbase++

LOCAL nSuccess
LOCAL oOauth1
LOCAL oRest
LOCAL nBUseQueryParams
LOCAL nBTls
LOCAL nPort
LOCAL nBAutoReconnect
LOCAL cResponseJson

nSuccess := 0

//  Demonstrates how to do OAuth1 authentication with query parameters (for a Wordpress site using Woo Commerce).

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Prepare an OAuth 1.0 object for use with the Chilkat REST API.
oOauth1 := CreateObject("Chilkat.OAuth1")
oOauth1:ConsumerKey := "WOO_COMMERCE_CONSUMER_KEY"
oOauth1:ConsumerSecret := "WOO_COMMERCE_CONSUMER_SECRET"

//  The signature method can be HMAC-SHA1 or HMAC-SHA256
oOauth1:SignatureMethod := "HMAC-SHA256"

//  The OauthUrl property will need to be updated each time a request is sent.
//  The domain here must match the domain passed to the Connect method (below).
//  The domain must be exact.  For example, "www.your-wordpress-site.com" vs. "your-wordpress-site.com".
//  One might work while the other does not..
oOauth1:OauthUrl := "http://your-wordpress-site.com/wc-api/v3/orders"

//  We need to tell OAuth1 about our extra query parameters so they can be used
//  in generating the OAuth1 signature.
//  In this example, we want to add the param "status=processing"
nSuccess := oOauth1:AddParam("status", "processing")

//  The OAuthMethod property will be set automatically when the REST request is sent.
//  Setting it here is not actually necessary.
oOauth1:OauthMethod := "GET"

//  Generate an initial nonce so that Chilkat knows the desired size of the nonce.
nSuccess := oOauth1:GenNonce(32)

oRest := CreateObject("Chilkat.Rest")

//  Tell the REST object to use the OAuth1 object for authentication.
//  Also, indicate that the OAuth authentication parameters should be query parameters
//  and not located within the Authorization header.
nBUseQueryParams := 1
nSuccess := oRest:SetAuthOAuth1(oOauth1, nBUseQueryParams)

//  Make the initial connection (without sending a request yet) to the WooCommerce endpoint at your Wordpress blog.
nBTls := 0
nPort := 80
nBAutoReconnect := 1
nSuccess := oRest:Connect("your-wordpress-site.com", nPort, nBTls, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oOauth1:destroy()
    oRest:destroy()
    RETURN
ENDIF

//  Send a GET request to list orders.

//  The extra query params must be added here.
//  (Whatever params are added here should've also been added to the OAuth1 object.)
nSuccess := oRest:AddQueryParam("status", "processing")

//  When the request is sent, the OAuth1 object's Timestamp and Nonce properties are automatically
//  regenerated.  Also, the OAuth1 object's OauthMethod property is automatically set to the HTTP method
//  used for the request (in this case it is "GET").
cResponseJson := oRest:FullRequestNoBody("GET", "/wc-api/v3/orders")
IF (oRest:LastMethodSuccess != 1)
    ? oRest:LastErrorText
    oOauth1:destroy()
    oRest:destroy()
    RETURN
ENDIF

//  When successful, the response status code will equal 200.
IF (oRest:ResponseStatusCode != 200)
    //  Examine the request/response to see what happened.
    ? "response status code = " + Str(oRest:ResponseStatusCode)
    ? "response status text = " + oRest:ResponseStatusText
    ? "response header: " + oRest:ResponseHeader
    ? "response body (if any): " + cResponseJson
    ? "---"
    ? "LastRequestStartLine: " + oRest:LastRequestStartLine
    ? "LastRequestHeader: " + oRest:LastRequestHeader
    oOauth1:destroy()
    oRest:destroy()
    RETURN
ENDIF

? cResponseJson
? "Success."

oOauth1:destroy()
oRest:destroy()