Delphi DLL

REST Follow Redirects

See more REST Examples

Demonstrates how to follow a 302/303 redirect response. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Url, Rest;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
rest: HCkRest;
bTls: Boolean;
port: Integer;
bAutoReconnect: Boolean;
responseText: PWideChar;
statusCode: Integer;
urlStr: PWideChar;
redirectUrl: HCkUrl;

begin
success := False;

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

rest := CkRest_Create();

bTls := True;
port := 443;
bAutoReconnect := True;
success := CkRest_Connect(rest,'chilkatsoft.com',port,bTls,bAutoReconnect);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// Send a POST to a URL that will respond with a 302 redirect..
CkRest_AddQueryParam(rest,'firstName','John');
CkRest_AddQueryParam(rest,'lastName','Doe');
responseText := CkRest__fullRequestFormUrlEncoded(rest,'POST','/echoPost302.asp');
if (CkRest_getLastMethodSuccess(rest) = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

statusCode := CkRest_getResponseStatusCode(rest);

// Examine the response status code
if (statusCode < 300) then
  begin
    Memo1.Lines.Add('Not a redirect.');
    Memo1.Lines.Add(responseText);
    Exit;
  end;

if (statusCode > 399) then
  begin
    Memo1.Lines.Add('Error response: Status code = ' + IntToStr(statusCode));
    Memo1.Lines.Add(responseText);
    Exit;
  end;

Memo1.Lines.Add('Redirect status code = ' + IntToStr(statusCode));

// 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.

Memo1.Lines.Add(CkRest__responseHeader(rest));

// Get the redirect URL
urlStr := CkRest__lastRedirectUrl(rest);
if (CkRest_getLastMethodSuccess(rest) = False) then
  begin
    Memo1.Lines.Add('No Location header found for redirect.');
    Exit;
  end;
redirectUrl := CkUrl_Create();
CkUrl_ParseUrl(redirectUrl,urlStr);

// Prep for the redirect..
CkRest_ClearAllParts(rest);

// Disconnect and re-connect.  
// (This can be skipped if both the host and SSL/TLS conditions are the same.)
CkRest_Disconnect(rest,100);
success := CkRest_Connect(rest,CkUrl__host(redirectUrl),CkUrl_getPort(redirectUrl),CkUrl_getSsl(redirectUrl),bAutoReconnect);
if (success = False) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

if ((statusCode = 301) or (statusCode = 307)) then
  begin
    // Redirect using a POST, sending the same params to the new destination
    CkRest_AddQueryParam(rest,'firstName','John');
    CkRest_AddQueryParam(rest,'lastName','Doe');
    responseText := CkRest__fullRequestFormUrlEncoded(rest,'POST',CkUrl__path(redirectUrl));
    if (CkRest_getLastMethodSuccess(rest) = False) then
      begin
        Memo1.Lines.Add(CkRest__lastErrorText(rest));
        Exit;
      end;

  end;

if ((statusCode = 302) or (statusCode = 303)) then
  begin
    // Redirect using a GET, sending the query params found in the redirect URL.
    responseText := CkRest__fullRequestFormUrlEncoded(rest,'GET',CkUrl__pathWithQueryParams(redirectUrl));
    if (CkRest_getLastMethodSuccess(rest) = False) then
      begin
        Memo1.Lines.Add(CkRest__lastErrorText(rest));
        Exit;
      end;

  end;

// Show the final status code and the response text.
Memo1.Lines.Add('Final status code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));

Memo1.Lines.Add('Final response text (HTML, XML, JSON, or whatever..)');
Memo1.Lines.Add(responseText);

CkRest_Dispose(rest);
CkUrl_Dispose(redirectUrl);

end;