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

PowerBuilder 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

 

 

 

(PowerBuilder) Using the OAuth2 Authorization Token in REST API Calls

Demonstrates how to use an OAuth2 authorization token in REST API calls after obtaining it.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Json
integer li_Success
string ls_AccessToken
oleobject loo_Http
string ls_ResponseStr
oleobject loo_Req
oleobject loo_Resp
oleobject loo_Rest
oleobject loo_SbAuthHeaderVal

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

// This example demonstrates how to include the OAuth2 authorization token in HTTP requests (REST API calls).
// An OAuth2 authorization token is typically in JSON format, and looks something like this:

// {
//   "token_type": "Bearer",
//   "scope": "openid profile User.ReadWrite Mail.ReadWrite Mail.Send Files.ReadWrite User.Read Calendars.ReadWrite Group.ReadWrite.All",
//   "expires_in": 3600,
//   "ext_expires_in": 3600,
//   "access_token": "EwCQA8l6...rW5az09bI0C",
//   "refresh_token": "MCZhZ...6jBNRcpuQW",
//   "id_token": "eyJ0eXAi...kcuQQrT03jMyA",
//   "expires_on": "1569281808"
// }

// A few notes about the JSON above:
// 
// 1) Different OAuth2 implementations (servers) may have different JSON members. 
//    The important ones for this discussion are "access_token" and "refresh_token".   
//    These members should always be named exactly "access_token" and "refresh_token".  
//    (I've never seen them named differently, although I don't think it's a formal standard.)
// 
// 2) The "id_token" is present if you obtained the OAuth2 authorization token including "openid" in the scope.
//    It contains information about the user.  It is a JWT (per the OIDC specification) and here is the Chilkat
//    example for decoding the id_token.
// 
// 3) If you don't have a "refresh_token" in your JSON, some REST API's require "offline_access" to be included
//    in the scope when obtaining the OAuth2 token.
// 
// 4) IMPORTANT: Quite often, access_token's are only valid for a limited amount of time.  (Often just 1 hour (i.e. 3600 seconds)).
//    When the access token expires, your HTTP request will fail with a 401 Unauthorized status response.  This is where your application
//    can automatically recover by fetching a new access_token and re-sending the request.  I'll explain...  
//    Usually getting an OAuth2 token for a user requires interactive approval from the user in a browser.
//    However, refreshing the access_token does NOT require user interaction.  You should design
//    your application to automatically recover from an expired access token by 
//    (A) Automatically fetch a new access_token using the refresh_token as shown in this example.
//    (B) Persist the new JSON to wherever you're storing the access token, such as in a file or database record.  You'll need it for the next time you refresh.
//    (C) Update the http.AuthToken or rest.Authorization property (as shown below)
//    (D) Re-send the request using the updated auth token.
//    The above 4 steps (A, B, C, D) can be automatic such that the user never notices, except for a small delay in performance.

// When your application obtains the OAuth2 access token, it should store the JSON in persistent manner, such as in 
// a file, a database record, etc.  The "access_token" is used by your application when sending REST requests.  Typically, it is sent
// in the Authorization request header.  For example:
// 
// Authorization: Bearer <token>
// 

// -----
// Chilkat has two classes for sending HTTP requests.  One is named "Http" and the other is named "Rest".  Either can be used.  
// Once you become familiar with both, you'll find that some requests are more convenient to code in one or the other.
// 
// I'll demonstrate how to get the access_token from the JSON and add the Authorization header for both cases.
// 

// ----
// ---- (1) Get the access_token ----
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
if li_rc < 0 then
    destroy loo_Json
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_Json.LoadFile("qa_data/tokens/myToken.json")
if li_Success <> 1 then
    Write-Debug loo_Json.LastErrorText
    destroy loo_Json
    return
end if

// Get the access_token member.
ls_AccessToken = loo_Json.StringOf("access_token")

// ----
// ---- (2) Demonstrate adding the "Authorization: Bearer <token>" header using Chilkat Http ----
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")

// Setting the AuthToken property causes the "Authorization: Bearer <token>" header to be added to each request.
loo_Http.AuthToken = ls_AccessToken

// For example:
ls_ResponseStr = loo_Http.QuickGetStr("https://example.com/someApiCall")

// Another example:
loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat_9_5_0.HttpRequest")

// ...
loo_Resp = loo_Http.PostUrlEncoded("https://example.com/someApiCall",loo_Req)
// ...
destroy loo_Resp
// In both of the above cases, the "Authorization: Bearer <token>" header is automatically added to each request.

// ----
// ---- (3) Add the Authorization header using Chilkat Rest ----
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat_9_5_0.Rest")

li_Success = loo_Rest.Connect("example.com",443,1,1)
// ...

// Set the Authorization property to "Bearer <token>"
loo_SbAuthHeaderVal = create oleobject
li_rc = loo_SbAuthHeaderVal.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_SbAuthHeaderVal.Append("Bearer ")
loo_SbAuthHeaderVal.Append(ls_AccessToken)
loo_Rest.Authorization = loo_SbAuthHeaderVal.GetAsString()

// All requests sent by the rest object will now include the "Authorization: Bearer <token>" header.

// For example:
ls_ResponseStr = loo_Rest.FullRequestNoBody("GET","/someApiCall")


destroy loo_Json
destroy loo_Http
destroy loo_Req
destroy loo_Rest
destroy loo_SbAuthHeaderVal

 

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