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

Perl 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

 

 

 

(Perl) Debug REST HTTP Request

Demonstrates how to generate the HTTP Request (with all headers intact) without actually sending the request.

Note: This example requires Chilkat v9.5.0.77 or later.

Chilkat Perl Downloads

Perl Module for Windows, Linux, Alpine Linux,
MAC OS X, Solaris, FreeBSD, OpenBSD,
Raspberry Pi and other single board computers

use chilkat();

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

# This example will connect to the web server, but does not actually send a request.
# When in DebugMode, the request is composed in memory and can be retrieved by calling
# GetLastDebugRequest.

$rest = chilkat::CkRest->new();

# Connect Code...
# URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
$bTls = 1;
$port = 443;
$bAutoReconnect = 1;
$success = $rest->Connect("test-api.service.hmrc.gov.uk",$port,$bTls,$bAutoReconnect);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# Build the request body...
$json = chilkat::CkJsonObject->new();
$json->UpdateString("periodKey","A001");
$json->UpdateNumber("vatDueSales","105.50");
$json->UpdateNumber("vatDueAcquisitions","-100.45");
$json->UpdateNumber("totalVatDue","5.05");
$json->UpdateNumber("vatReclaimedCurrPeriod","105.15");
$json->UpdateNumber("netVatDue","100.10");
$json->UpdateInt("totalValueSalesExVAT",300);
$json->UpdateInt("totalValuePurchasesExVAT",300);
$json->UpdateInt("totalValueGoodsSuppliedExVAT",3000);
$json->UpdateInt("totalAcquisitionsExVAT",3000);
$json->UpdateBool("finalised",1);

# Add Headers...
$rest->AddHeader("Accept","application/vnd.hmrc.1.0+json");
$rest->AddHeader("Authorization","Bearer HMRC_ACCESS_TOKEN");
$rest->AddHeader("Content-Type","application/json");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);

# Set DebugMode so that no request is actually sent.
$rest->put_DebugMode(1);

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestSb("POST","/organisations/vat/MY_HMRC_VRN/returns",$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# Get the exact contents of what would've been sent.
# This includes the HTTP start line, the HTTP request headers, and the request body.
# Given that it's possible for the request body to contain binary data,
# the GetLastDebugRequest fetches into a BinData object.
# In this case, however, our request body contained JSON, so we can
# examine it as a string..
$bdRequest = chilkat::CkBinData->new();
$success = $rest->GetLastDebugRequest($bdRequest);

print "----" . "\r\n";
print $bdRequest->getString("utf-8") . "\r\n";
print "----" . "\r\n";

# The output for the above case:

# POST /organisations/vat/MY_HMRC_VRN/returns HTTP/1.1
# Accept: application/vnd.hmrc.1.0+json
# Host: test-api.service.hmrc.gov.uk
# Authorization: Bearer HMRC_ACCESS_TOKEN
# Content-Type: application/json
# Content-Length: 281
# 
# {"periodKey":"A001","vatDueSales":105.50, ... ,"finalised":true}
# 
# 

 

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