C

REST Follow Redirects

See more REST Examples

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

#include <C_CkRest.h>
#include <C_CkUrl.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRest rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    const char *responseText;
    int statusCode;
    const char *urlStr;
    HCkUrl redirectUrl;

    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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    // 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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        return;
    }

    statusCode = CkRest_getResponseStatusCode(rest);

    // Examine the response status code
    if (statusCode < 300) {
        printf("Not a redirect.\n");
        printf("%s\n",responseText);
        CkRest_Dispose(rest);
        return;
    }

    if (statusCode > 399) {
        printf("Error response: Status code = %d\n",statusCode);
        printf("%s\n",responseText);
        CkRest_Dispose(rest);
        return;
    }

    printf("Redirect status code = %d\n",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.

    printf("%s\n",CkRest_responseHeader(rest));

    // Get the redirect URL
    urlStr = CkRest_lastRedirectUrl(rest);
    if (CkRest_getLastMethodSuccess(rest) == FALSE) {
        printf("No Location header found for redirect.\n");
        CkRest_Dispose(rest);
        return;
    }

    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) {
        printf("%s\n",CkRest_lastErrorText(rest));
        CkRest_Dispose(rest);
        CkUrl_Dispose(redirectUrl);
        return;
    }

    if ((statusCode == 301) || (statusCode == 307)) {
        // 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) {
            printf("%s\n",CkRest_lastErrorText(rest));
            CkRest_Dispose(rest);
            CkUrl_Dispose(redirectUrl);
            return;
        }

    }

    if ((statusCode == 302) || (statusCode == 303)) {
        // 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) {
            printf("%s\n",CkRest_lastErrorText(rest));
            CkRest_Dispose(rest);
            CkUrl_Dispose(redirectUrl);
            return;
        }

    }

    // Show the final status code and the response text.
    printf("Final status code = %d\n",CkRest_getResponseStatusCode(rest));

    printf("Final response text (HTML, XML, JSON, or whatever..)\n");
    printf("%s\n",responseText);


    CkRest_Dispose(rest);
    CkUrl_Dispose(redirectUrl);

    }