DataFlex

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 DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vOauth1
    Handle hoOauth1
    Handle hoRest
    Boolean iBUseQueryParams
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    String sResponseJson
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

    Move False To iSuccess

    // 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.
    Get Create (RefClass(cComChilkatOAuth1)) To hoOauth1
    If (Not(IsComObjectCreated(hoOauth1))) Begin
        Send CreateComObject of hoOauth1
    End
    Set ComConsumerKey Of hoOauth1 To "WOO_COMMERCE_CONSUMER_KEY"
    Set ComConsumerSecret Of hoOauth1 To "WOO_COMMERCE_CONSUMER_SECRET"

    // The signature method can be HMAC-SHA1 or HMAC-SHA256
    Set ComSignatureMethod Of hoOauth1 To "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..
    Set ComOauthUrl Of hoOauth1 To "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"
    Get ComAddParam Of hoOauth1 "status" "processing" To iSuccess

    // The OAuthMethod property will be set automatically when the REST request is sent.
    // Setting it here is not actually necessary.
    Set ComOauthMethod Of hoOauth1 To "GET"

    // Generate an initial nonce so that Chilkat knows the desired size of the nonce.
    Get ComGenNonce Of hoOauth1 32 To iSuccess

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // 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.
    Move True To iBUseQueryParams
    Get pvComObject of hoOauth1 to vOauth1
    Get ComSetAuthOAuth1 Of hoRest vOauth1 iBUseQueryParams To iSuccess

    // Make the initial connection (without sending a request yet) to the WooCommerce endpoint at your Wordpress blog.
    Move False To iBTls
    Move 80 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "your-wordpress-site.com" iPort iBTls iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // 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.)
    Get ComAddQueryParam Of hoRest "status" "processing" To iSuccess

    // 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").
    Get ComFullRequestNoBody Of hoRest "GET" "/wc-api/v3/orders" To sResponseJson
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // When successful, the response status code will equal 200.
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 200) Begin
        // Examine the request/response to see what happened.
        Get ComResponseStatusCode Of hoRest To iTemp1
        Showln "response status code = " iTemp1
        Get ComResponseStatusText Of hoRest To sTemp1
        Showln "response status text = " sTemp1
        Get ComResponseHeader Of hoRest To sTemp1
        Showln "response header: " sTemp1
        Showln "response body (if any): " sResponseJson
        Showln "---"
        Get ComLastRequestStartLine Of hoRest To sTemp1
        Showln "LastRequestStartLine: " sTemp1
        Get ComLastRequestHeader Of hoRest To sTemp1
        Showln "LastRequestHeader: " sTemp1
        Procedure_Return
    End

    Showln sResponseJson
    Showln "Success."


End_Procedure