PureBasic

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 PureBasic

IncludeFile "CkRest.pb"
IncludeFile "CkOAuth1.pb"

Procedure ChilkatExample()

    success.i = 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.
    oauth1.i = CkOAuth1::ckCreate()
    If oauth1.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkOAuth1::setCkConsumerKey(oauth1, "WOO_COMMERCE_CONSUMER_KEY")
    CkOAuth1::setCkConsumerSecret(oauth1, "WOO_COMMERCE_CONSUMER_SECRET")

    ; The signature method can be HMAC-SHA1 or HMAC-SHA256
    CkOAuth1::setCkSignatureMethod(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::setCkOauthUrl(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"
    success = CkOAuth1::ckAddParam(oauth1,"status","processing")

    ; The OAuthMethod property will be set automatically when the REST request is sent.
    ; Setting it here is not actually necessary.
    CkOAuth1::setCkOauthMethod(oauth1, "GET")

    ; Generate an initial nonce so that Chilkat knows the desired size of the nonce.
    success = CkOAuth1::ckGenNonce(oauth1,32)

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    bUseQueryParams.i = 1
    success = CkRest::ckSetAuthOAuth1(rest,oauth1,bUseQueryParams)

    ; Make the initial connection (without sending a request yet) to the WooCommerce endpoint at your Wordpress blog.
    bTls.i = 0
    port.i = 80
    bAutoReconnect.i = 1
    success = CkRest::ckConnect(rest,"your-wordpress-site.com",port,bTls,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkOAuth1::ckDispose(oauth1)
        CkRest::ckDispose(rest)
        ProcedureReturn
    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.)
    success = CkRest::ckAddQueryParam(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").
    responseJson.s = CkRest::ckFullRequestNoBody(rest,"GET","/wc-api/v3/orders")
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkOAuth1::ckDispose(oauth1)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    ; When successful, the response status code will equal 200.
    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseJson
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkOAuth1::ckDispose(oauth1)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

    Debug responseJson
    Debug "Success."


    CkOAuth1::ckDispose(oauth1)
    CkRest::ckDispose(rest)


    ProcedureReturn
EndProcedure