AutoIt

REST Follow Redirects

See more REST Examples

Demonstrates how to follow a 302/303 redirect response. AutoIt

Local $bSuccess = False

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

$oRest = ObjCreate("Chilkat.Rest")

Local $bTls = True
Local $iPort = 443
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("chilkatsoft.com",$iPort,$bTls,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; Send a POST to a URL that will respond with a 302 redirect..
$oRest.AddQueryParam("firstName","John")
$oRest.AddQueryParam("lastName","Doe")
Local $sResponseText = $oRest.FullRequestFormUrlEncoded("POST","/echoPost302.asp")
If ($oRest.LastMethodSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

Local $iStatusCode = $oRest.ResponseStatusCode

; Examine the response status code
If ($iStatusCode < 300) Then
    ConsoleWrite("Not a redirect." & @CRLF)
    ConsoleWrite($sResponseText & @CRLF)
    Exit
EndIf

If ($iStatusCode > 399) Then
    ConsoleWrite("Error response: Status code = " & $iStatusCode & @CRLF)
    ConsoleWrite($sResponseText & @CRLF)
    Exit
EndIf

ConsoleWrite("Redirect status code = " & $iStatusCode & @CRLF)

; The response header will contain a Location field with the redirect URL, such as this:
; Location: http://www.chilkatsoft.com/echoPostFinal.asp

; The response status code determines how the client should behave.
; Here are some common possibilities:

; 301: Moved Permanently
; This and all future requests should be directed to the given URI.  (Keep the original HTTP method for the redirect.  In this case, the 
; original request was a POST, so we POST to the redirect URL.)

; 302: Found (aka Object Moved aka Moved Temporarily)
; This is the most popular redirect code, but also an example of industrial practice contradicting the standard. HTTP/1.0 specification (RFC 1945 ) required the client
; to perform a temporary redirect (the original describing phrase was �Moved Temporarily�), but popular browsers implemented it as a 303 See Other. Therefore, HTTP/1.1
; added status codes 303 and 307 to disambiguate between the two behaviors. However, the majority of Web applications and frameworks still use the 302 status code
; as if it were the 303.

; 303: See Other
; The response to the request can be found under another URI using a GET method. When received in response to a PUT, it should be assumed that the server has
; received the data and the redirect should be issued with a separate GET message.

; 307: Temporary Redirect
; In this occasion, the request should be repeated with another URI, but future requests can still use the original URI. In contrast to 303, the request method
; should not be changed when reissuing the original request. For instance, a POST request must be repeated using another POST request.

ConsoleWrite($oRest.ResponseHeader & @CRLF)

; Get the redirect URL
Local $sUrlStr = $oRest.LastRedirectUrl
If ($oRest.LastMethodSuccess = False) Then
    ConsoleWrite("No Location header found for redirect." & @CRLF)
    Exit
EndIf

$oRedirectUrl = ObjCreate("Chilkat.Url")
$oRedirectUrl.ParseUrl($sUrlStr)

; Prep for the redirect..
$oRest.ClearAllParts()

; Disconnect and re-connect.  
; (This can be skipped if both the host and SSL/TLS conditions are the same.)
$oRest.Disconnect(100)
$bSuccess = $oRest.Connect($oRedirectUrl.Host,$oRedirectUrl.Port,$oRedirectUrl.Ssl,$bAutoReconnect)
If ($bSuccess = False) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

If (($iStatusCode = 301) Or ($iStatusCode = 307)) Then
    ; Redirect using a POST, sending the same params to the new destination
    $oRest.AddQueryParam("firstName","John")
    $oRest.AddQueryParam("lastName","Doe")
    $sResponseText = $oRest.FullRequestFormUrlEncoded("POST",$oRedirectUrl.Path)
    If ($oRest.LastMethodSuccess = False) Then
        ConsoleWrite($oRest.LastErrorText & @CRLF)
        Exit
    EndIf

EndIf

If (($iStatusCode = 302) Or ($iStatusCode = 303)) Then
    ; Redirect using a GET, sending the query params found in the redirect URL.
    $sResponseText = $oRest.FullRequestFormUrlEncoded("GET",$oRedirectUrl.PathWithQueryParams)
    If ($oRest.LastMethodSuccess = False) Then
        ConsoleWrite($oRest.LastErrorText & @CRLF)
        Exit
    EndIf

EndIf

; Show the final status code and the response text.
ConsoleWrite("Final status code = " & $oRest.ResponseStatusCode & @CRLF)

ConsoleWrite("Final response text (HTML, XML, JSON, or whatever..)" & @CRLF)
ConsoleWrite($sResponseText & @CRLF)