Skip to content

http.md

Latest commit

 

History

History
173 lines (149 loc) · 5.05 KB

http.md

File metadata and controls

173 lines (149 loc) · 5.05 KB
Raw

Deprecated: The HTTP library is deprecated and may be removed in a future release. Use the fetch library instead.

The HTTP library is a library for making HTTP calls to external services. It supports four HTTP verbs (GET,POST,DELETE,PUT).

Class: Requests

The Requests class is invoked to get an HTTP requesting object. Note that it depends on the ClearBlade object, so the ClearBlade object must also be included in your service.

HTTP Request Options

Options passed into each request

  • uri: The url to be requested
  • qs: Query string parameters
  • body: Request Payload, in the form of a JSON Object. Not valid on verbs that do not have bodies (such as DELETE or GET).
  • form: only applicable on the POST method.
  • headers: Header properties to be passed of the request
  • followRedirect: a number, the maximum number of redirects to follow
  • timeout: The amount of seconds to wait for a response
  • auth: Support for HTTP basic auth. the object must have the "user" and "pass" keys. all others will be ignored.
  • strictSSL: Fails the request if the identity on the SSL certificate cannot be verified. set to false to use with self-signed certs
  • getProxyUrl: If you are using a proxy to call the outside world, and need to get the proxy URL from an environment variable, set this to true
  • isSoap: Force an XML based response
  • full: This adds Body, Status, and Header to the response so that developers can have access to the full response. Only the data from the Body will be returned if the property isn't set.

request.get

Simple HTTP get Example

	//get a Requests object
	var requestObject = Requests();
    var options = {
        uri:"https://httpbin.org/get"
    }
    requestObject.get(options,function(err, data){
        if(err){
            resp.error("Unable to HTTP GET: " + JSON.stringify(err))
        }
        resp.success(data)
    })
}

Advanced HTTP get Example

//get a Requests object
var requestObject = Requests();

//options are fed into each object.
var options = {
    "uri":"https://google.com",
    "qs": {"q":"clearblade platform"},
    "body": {msg:"hello world"},
    "form":true,
    "headers": {"Content-Type" : "application/json","date":"Thu, 13 Aug 2015 21:24:53 GMT","Server":"nginx/1.2.1"},
    "followRedirect":12, 
    "timeout":30,
    "auth":{"user":"me","pass":"secret"},
    "strictSSL":false,
    "getProxyUrl":false,
    "isXML":true,
    "isSoap":true,
    "full": true  
}

requestObject.get(options,function(err, data){
    if(err){
        resp.error("Unable to HTTP GET: " + JSON.stringify(err))
    }
    resp.success(data)
})

request.post

Execute POST on the http request object

//performs a POST request
requestObject.post(options,function(err,body){
	if(err){
		//the error is a JSON value of the error in question, shaped like {"error":"message"}
	}else{
		//body is JSON of the response
	}
})

request.delete

Execute DELETE on the request object

//performs a delete
requestObject.delete(options,function(err,body){
	if(err){
		//the error is a JSON value of the error in question, shaped like {"error":"message"}
	}else{
		//body is JSON of the response
	}
})

request.put

Execute PUT on the request object

//performs a put
requestObject.put(options,function(err,body){
	if(err){
		//the error is a JSON value of the error in question, shaped like {"error":"message"}
	}else{
		//body is JSON of the response
	}
})

Example using Full property

function testHttpFull(req,resp){
    const req = Requests();
    req.get({
        uri: "https://api.openweathermap.org/data/2.5/weather?q=Austin&appid=0f84b67b5728e6e8ca9fdefae37162c7",
        full: true
    }, function(err, data) {
        if (err) {
            resp.error(err);
        } else {
            resp.success(data);
        }
    })
}

This will return:

{
  "Body": "{\"coord\":{\"lon\":-97.74,\"lat\":30.27},\"weather\":[{\"id\":804,\"main\":\"Clouds\",\"description\":\"overcast clouds\",\"icon\":\"04d\"}],\"base\":\"stations\",\"main\":{\"temp\":279.27,\"feels_like\":275.27,\"temp_min\":278.15,\"temp_max\":280.37,\"pressure\":1016,\"humidity\":81},\"visibility\":10000,\"wind\":{\"speed\":3.6,\"deg\":310,\"gust\":8.2},\"clouds\":{\"all\":90},\"dt\":1603902142,\"sys\":{\"type\":1,\"id\":3344,\"country\":\"US\",\"sunrise\":1603888949,\"sunset\":1603928803},\"timezone\":-18000,\"id\":4671654,\"name\":\"Austin\",\"cod\":200}",
  "Header": {
    "Access-Control-Allow-Credentials": [
      "true"
    ],
    "Access-Control-Allow-Methods": [
      "GET, POST"
    ],
    "Access-Control-Allow-Origin": [
      "*"
    ],
    "Connection": [
      "keep-alive"
    ],
    "Content-Length": [
      "484"
    ],
    "Content-Type": [
      "application/json; charset=utf-8"
    ],
    "Date": [
      "Wed, 28 Oct 2020 16:29:10 GMT"
    ],
    "Server": [
      "openresty"
    ],
    "X-Cache-Key": [
      "/data/2.5/weather?q=austin"
    ]
  },
  "Status": 200
}