Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PureBasic Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PureBasic) Creating an application/json HTTP POST Request

Demonstrates how to create an HTTP POST request having the Content-Type application/json, where the body of the HTTP request is the following JSON:

{
   "username" : "my_username",
   "password" : "my_password",
   "validation-factors" : {
      "validationFactors" : [
         {
            "name" : "remote_address",
            "value" : "127.0.0.1"
         }
      ]
   }
}

The generated HTTP request looks like this:

POST /something HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: domain
Content-Length: 216

{
  "username": "my_username",
  "password": "my_password",
  "validation-factors": {
    "validationFactors": [
      {
        "name": "remote_address",
        "value": "127.0.0.1"
      }
    ]
  }
}

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkJsonArray.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

    ;  This example demonstrates building an application/json request.

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ;  The ContentType, HttpVerb, and Path properties should
    ;  always be explicitly set.
    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, "/something")
    CkHttpRequest::setCkContentType(req, "application/json")

    ;  We may wish to add an "Accept" header to the request.
    ;  This tells the server we'll accept an application/json response.
    CkHttpRequest::ckAddHeader(req,"Accept","application/json")

    ;  We'll use Chilkat's JSON API to create the JSON body of the HTTP request.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckAppendString(json,"username","my_username")
    CkJsonObject::ckAppendString(json,"password","my_password")
    vFactors.i = CkJsonObject::ckAppendObject(json,"validation-factors")
    vArray.i = CkJsonObject::ckAppendArray(vFactors,"validationFactors")
    CkJsonArray::ckAddObjectAt(vArray,0)
    factorObj.i = CkJsonArray::ckObjectAt(vArray,0)
    CkJsonObject::ckAppendString(factorObj,"name","remote_address")
    CkJsonObject::ckAppendString(factorObj,"value","127.0.0.1")
    CkJsonObject::ckDispose(factorObj)

    CkJsonArray::ckDispose(vArray)

    CkJsonObject::ckDispose(vFactors)

    ;  Use the JSON for the HTTP request body
    ;  By default, the Emit method will output compact JSON.
    ;  This is best for generating the smallest size request.
    ;  To generate a more human-readable (pretty-printed) JSON request body,
    ;  set the EmitCompact property to FALSE
    CkJsonObject::setCkEmitCompact(json, 0)
    CkHttpRequest::ckLoadBodyFromString(req,CkJsonObject::ckEmit(json),"utf-8")

    ;  View the request that would be sent if SynchronousRequest was called:
    requestMime.s = CkHttpRequest::ckGenerateRequestText(req)
    Debug requestMime

    ;  A few important comments about the HTTP request that is generated:
    ; 
    ;  1) The Content-Length header is automatically generated based on the actual length of the MIME message
    ;     that follows the intial (topmost) MIME header.
    ;  2) The HOST header will automatically get filled in with the actual domain when SynchronousRequest
    ;     is called.


    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.