PowerBuilder

Use Socket Object for the Connection

See more REST Examples

The Chilkat Socket API provides many features for establishing connections, which includes the following:

• Connect through an HTTP proxy
• Connect through a SOCKS proxy
• Connect through an SSH tunnel
• Binding to a local IP address
• Client-side Certificates (two-way SSL/TLS)
• Public Key Pinning for TLS connections
• Controlling TLS ciphers

Rather than reproducing all of the properties and methods required for these features, the REST object can use a Socket object's connection by calling the UseConnection method. This allows for an application to use the features of the Socket API to establish the connection, and then use it from the REST API.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Rest
oleobject loo_Socket
integer li_BTls
integer li_Port
integer li_MaxWaitMs
integer li_BAutoReconnect
string ls_ResponseJson

li_Success = 0

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

// This example shows how to use the Chilkat socket object's connection.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if
loo_Socket = create oleobject
li_rc = loo_Socket.ConnectToNewObject("Chilkat.Socket")

// Establish the connection using the socket object:
li_BTls = 1
li_Port = 443
li_MaxWaitMs = 5000
li_Success = loo_Socket.Connect("www.alphavantage.co",li_Port,li_BTls,li_MaxWaitMs)
if li_Success <> 1 then
    Write-Debug "Connect Failure Error Code: " + string(loo_Socket.ConnectFailReason)
    Write-Debug loo_Socket.LastErrorText
    destroy loo_Rest
    destroy loo_Socket
    return
end if

li_BAutoReconnect = 1

// Use the connection:
li_Success = loo_Rest.UseConnection(loo_Socket,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Socket
    return
end if

// Get a stock quote:
// Sending GET request to https://www.alphavantage.co/query?function=TIME_SERIES_DAILY&symbol=MSFT&apikey=my_api_key
li_Success = loo_Rest.AddQueryParam("function","TIME_SERIES_DAILY")
li_Success = loo_Rest.AddQueryParam("symbol","AAPL")
li_Success = loo_Rest.AddQueryParam("apikey","my_api_key")
ls_ResponseJson = loo_Rest.FullRequestNoBody("GET","/query")
if loo_Rest.LastMethodSuccess <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_Socket
    return
end if

Write-Debug ls_ResponseJson

// Sample response:
// {
//     "Meta Data": {
//         "1. Information": "Daily Prices (open, high, low, close) and Volumes",
//         "2. Symbol": "AAPL",
//         "3. Last Refreshed": "2019-12-06",
//         "4. Output Size": "Compact",
//         "5. Time Zone": "US/Eastern"
//     },
//     "Time Series (Daily)": {
//         "2019-12-06": {
//             "1. open": "267.4800",
//             "2. high": "271.0000",
//             "3. low": "267.3000",
//             "4. close": "270.7100",
//             "5. volume": "25447644"
//         },
//         "2019-12-05": {
//             "1. open": "263.7900",
//             "2. high": "265.8900",
//             "3. low": "262.7300",
//             "4. close": "265.5800",
//             "5. volume": "18661343"
//         },
//         "2019-12-04": {
//             "1. open": "261.0700",
//             "2. high": "263.3100",
//             "3. low": "260.6800",
//             "4. close": "261.7400",
//             "5. volume": "16810388"
//         },
// ...
//         "2019-07-18": {
//             "1. open": "204.0000",
//             "2. high": "205.8800",
//             "3. low": "203.7000",
//             "4. close": "205.6600",
//             "5. volume": "18582161"
//         }
//     }
// }


destroy loo_Rest
destroy loo_Socket