(CkPython) POST application/x-www-form-urlencoded Two Ways

This example explains how a POST with params can be formatted in different ways. Params can be encoded in the URL, in which case they appear in the "start line" of the HTTP request, or params can be placed within the body of the request. A properly implemented server SHOULD accept both -- it SHOULD make no difference where the params are located. They are simply the params of a POST. But alas, many servers are not, and we need to cope with the particulars..

Chilkat Python Downloads install with pip pip3 install chilkat or download... Python Module for Windows, MacOS, Linux, Alpine Linux, Solaris

import sys
import chilkat

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

# We start with this CURL statement:

# curl -X POST "https://xyz.softeon.com/api/token?grant_type=client_credentials&resource=https://xyz.softeon.com/resources&scope=openid&client_id=AAA&client_secret=BBB" -H "Content-Type: application/x-www-form-urlencoded"

# Postman would send the following request:

# POST /api/token?grant_type=client_credentials&resource=https://xyz.softeon.com/resources&scope=openid&client_id=AAA&client_secret=BBB HTTP/1.1
# Content-Type: application/x-www-form-urlencoded
# User-Agent: PostmanRuntime/7.26.8
# Accept: */*
# Cache-Control: no-cache
# Postman-Token: 719e6ada-5b0e-4d3f-8166-37433efdcaa1
# Host: xyz.softeon.com
# Accept-Encoding: gzip, deflate, br
# Connection: keep-alive
# Content-Length: 0

# We can see that the params are located in the "start line" of the HTTP request, and the request has no body (the Content-Length is 0).

# You can use Chilkat's online tool to generate the code for the above CURL statement.
# Generate Source Code from CURL Statement
# 

# Here's the generated code:

http = chilkat.CkHttp()

# We can see the exact HTTP request sent by setting a session log filename:
http.put_SessionLogFilename("qa_output/sessionLog.txt")

http.SetRequestHeader("Content-Type","application/x-www-form-urlencoded")

# resp is a CkHttpResponse
resp = http.QuickRequest("POST","https://xyz.softeon.com/api/token?grant_type=client_credentials&resource=https://xyz.softeon.com/resources&scope=openid&client_id=AAA&client_secret=BBB")
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

print("Response body:")
print(resp.bodyStr())

# Here's what is sent by Chilkat.  It is essentially the same thing:

# POST /api/token?grant_type=client_credentials&resource=https://xyz.softeon.com/resources&scope=openid&client_id=AAA&client_secret=BBB HTTP/1.1
# Host: xyz.softeon.com
# Accept: */*
# Accept-Encoding: gzip
# Content-Type: application/x-www-form-urlencoded
# Content-Length: 0

# -------------------------------------------------------------------------------------------------------------------------------------------------
# Now let's look at the alternative way of sending a POST application/x-www-form-urlencoded,
# where the params are contained within the body of the request.

# curl -X POST  https://xyz.softeon.com/api/token \
# -H 'Content-Type: application/x-www-form-urlencoded;charset=UTF-8' \
# -d 'grant_type=client_credentials' \
# -d 'resource=https://xyz.softeon.com/resources' \
# -d 'scope=openid' \
# -d 'client_id=AAA' \
# -d 'client_secret=BBB'

# The Chilkat tool at https://tools.chilkat.io/curlHttp.cshtml
# generates the following code:
# (We changed the names of the variables to keep things entirely separate from the above code.)

httpB = chilkat.CkHttp()

httpB.put_SessionLogFilename("qa_output/sessionLogB.txt")

reqB = chilkat.CkHttpRequest()
reqB.put_HttpVerb("POST")
reqB.put_Path("/api/token")
reqB.put_ContentType("application/x-www-form-urlencoded")
reqB.AddParam("grant_type","client_credentials")
reqB.AddParam("resource","https://xyz.softeon.com/resources")
reqB.AddParam("scope","openid")
reqB.AddParam("client_id","AAA")
reqB.AddParam("client_secret","BBB")

# respB is a CkHttpResponse
respB = httpB.PostUrlEncoded("https://xyz.softeon.com/api/token",reqB)
if (httpB.get_LastMethodSuccess() == False):
    print(httpB.lastErrorText())
    sys.exit()

print("Response body:")
print(respB.bodyStr())

# Looking at the sessionLogB.txt, we can see the following HTTP POST was sent:

# POST /api/token HTTP/1.1
# Host: xyz.softeon.com
# Content-Type: application/x-www-form-urlencoded
# Content-Length: 134
# 
# grant_type=client_credentials&resource=https%3A%2F%2Fxyz.softeon.com%2Fresources&scope=openid&client_id=AAA&client_secret=BBB

# --
# Notice how the params are sent in the body of the request.  The Content-Length is now non-zero, and the params are not present in the start-line of the HTTP request.
# Technically, this SHOULD be equivalent to the above request where the params are in the start-line.
# Unfortunately, many servers are brittle and stupid and want the POST to be in a particular form.