Tcl

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 Tcl

load ./chilkat.dll

set success 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.
set oauth1 [new_CkOAuth1]

CkOAuth1_put_ConsumerKey $oauth1 "WOO_COMMERCE_CONSUMER_KEY"
CkOAuth1_put_ConsumerSecret $oauth1 "WOO_COMMERCE_CONSUMER_SECRET"

# The signature method can be HMAC-SHA1 or HMAC-SHA256
CkOAuth1_put_SignatureMethod $oauth1 "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..
CkOAuth1_put_OauthUrl $oauth1 "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"
set success [CkOAuth1_AddParam $oauth1 "status" "processing"]

# The OAuthMethod property will be set automatically when the REST request is sent.
# Setting it here is not actually necessary.
CkOAuth1_put_OauthMethod $oauth1 "GET"

# Generate an initial nonce so that Chilkat knows the desired size of the nonce.
set success [CkOAuth1_GenNonce $oauth1 32]

set rest [new_CkRest]

# 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.
set bUseQueryParams 1
set success [CkRest_SetAuthOAuth1 $rest $oauth1 $bUseQueryParams]

# Make the initial connection (without sending a request yet) to the WooCommerce endpoint at your Wordpress blog.
set bTls 0
set port 80
set bAutoReconnect 1
set success [CkRest_Connect $rest "your-wordpress-site.com" $port $bTls $bAutoReconnect]
if {$success != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    exit
}

# 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.)
set success [CkRest_AddQueryParam $rest "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").
set responseJson [CkRest_fullRequestNoBody $rest "GET" "/wc-api/v3/orders"]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    exit
}

# When successful, the response status code will equal 200.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    # Examine the request/response to see what happened.
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body (if any): $responseJson"
    puts "---"
    puts "LastRequestStartLine: [CkRest_lastRequestStartLine $rest]"
    puts "LastRequestHeader: [CkRest_lastRequestHeader $rest]"
    delete_CkOAuth1 $oauth1
    delete_CkRest $rest
    exit
}

puts "$responseJson"
puts "Success."

delete_CkOAuth1 $oauth1
delete_CkRest $rest