sendgrid-rest / 2.2.1 last updated 14 days ago created on Apr 8th 2016

Install

npm install --save sendgrid-rest

Clone

git clone git@github.com:sendgrid/node-rest-client.git

dependencies

No dependencies listed.

maintainers

thinkingserious

versions 6 total

2.2.1	14 days ago	thinkingserious
2.2.0	19 days ago	thinkingserious
2.1.0	22 days ago	thinkingserious
2.0.0	24 days ago	thinkingserious
1.0.1	3 months ago	thinkingserious
1.0.0	3 months ago	thinkingserious

296 Downloads yesterday.

readme

Quickly and easily access any RESTful or RESTful-like API.

If you are looking for the SendGrid API client library, please see this repo.

Announcements

All updates to this library is documented in our CHANGELOG.

Installation

1	npm install sendgrid-rest

Quick Start

GET /your/api/{param}/call

var Client = require('sendgrid-rest').Client
var client = new Client()
var request = client.emptyRequest()
var param = 'myparam'
request.host = 'api.example.com'
request.method = 'GET'
request.path = '/your/api/' + param + '/call'
client.API(request, function (response) {
  console.log(response.statusCode)
  console.log(response.body)
  console.log(response.headers)
})

POST /your/api/{param}/call with headers, query parameters and a request body.

var Client = require('sendgrid-rest').Client
var client = new Client()
var request = client.emptyRequest()
request.host = 'api.example.com'
request.headers['Authorization'] = 'Bearer XXXXXX'
request.queryParams['limit'] = 100
request.queryParams['offset'] = 0
request.method = 'POST'
var param = 'myparam'
request.path = '/your/api/' + param + '/call'
requestBody = {
  'some': 0,
  'awesome': 1,
  'data': 3
}
request.body = requestBody
client.API(request, function (response) {
  console.log(response.statusCode)
  console.log(response.body)
  console.log(response.headers)
})

Usage

Following is an example using SendGrid. You can get your free account here.

First, update your environment with your SENDGRID_API_KEY.

1
2
3

echo "export SENDGRID_API_KEY='YOUR_API_KEY'" > sendgrid.env
echo "sendgrid.env" >> .gitignore
source ./sendgrid.env

Here is the full working code.

To run the example:

1	node examples/example

Roadmap

If you are intersted in the future direction of this project, please take a look at our milestones. We would love to hear your feedback.

How to Contribute

We encourage contribution to our libraries, please see our CONTRIBUTING guide for details.

About

nodejs-http-client is guided and supported by the SendGrid Developer Experience Team.

nodejs-http-client is maintained and funded by SendGrid, Inc. The names and logos for nodejs-http-client are trademarks of SendGrid, Inc.

![SendGrid Logo] (https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png)