Visual FoxPro

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.

Visual FoxPro

LOCAL lnSuccess
LOCAL loRest
LOCAL loSocket
LOCAL lnBTls
LOCAL lnPort
LOCAL lnMaxWaitMs
LOCAL lnBAutoReconnect
LOCAL lcResponseJson

lnSuccess = 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.
loRest = CreateObject('Chilkat.Rest')
loSocket = CreateObject('Chilkat.Socket')

* Establish the connection using the socket object:
lnBTls = 1
lnPort = 443
lnMaxWaitMs = 5000
lnSuccess = loSocket.Connect("www.alphavantage.co",lnPort,lnBTls,lnMaxWaitMs)
IF (lnSuccess <> 1) THEN
    ? "Connect Failure Error Code: " + STR(loSocket.ConnectFailReason)
    ? loSocket.LastErrorText
    RELEASE loRest
    RELEASE loSocket
    CANCEL
ENDIF

lnBAutoReconnect = 1

* Use the connection:
lnSuccess = loRest.UseConnection(loSocket,lnBAutoReconnect)
IF (lnSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loSocket
    CANCEL
ENDIF

* Get a stock quote:
* Sending GET request to https://www.alphavantage.co/query?function=TIME_SERIES_DAILY&symbol=MSFT&apikey=my_api_key
lnSuccess = loRest.AddQueryParam("function","TIME_SERIES_DAILY")
lnSuccess = loRest.AddQueryParam("symbol","AAPL")
lnSuccess = loRest.AddQueryParam("apikey","my_api_key")
lcResponseJson = loRest.FullRequestNoBody("GET","/query")
IF (loRest.LastMethodSuccess <> 1) THEN
    ? loRest.LastErrorText
    RELEASE loRest
    RELEASE loSocket
    CANCEL
ENDIF

? lcResponseJson

* 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"
*         }
*     }
* }

RELEASE loRest
RELEASE loSocket