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

Prerequisites

• Node.js version 0.10, 0.12 or 4

Install Package

1npm install sendgrid-rest

Quick Start

GET /your/api/{param}/call

1var Client = require('sendgrid-rest').Client
2var client = new Client()
3var request = client.emptyRequest()
4var param = 'myparam'
5request.host = 'api.example.com'
6request.method = 'GET'
7request.path = '/your/api/' + param + '/call'
8client.API(request, function (response) {
9  console.log(response.statusCode)
10  console.log(response.body)
11  console.log(response.headers)
12})

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

1var Client = require('sendgrid-rest').Client
2var client = new Client()
3var request = client.emptyRequest()
4request.host = 'api.example.com'
5request.headers['Authorization'] = 'Bearer XXXXXX'
6request.queryParams['limit'] = 100
7request.queryParams['offset'] = 0
8request.method = 'POST'
9var param = 'myparam'
10request.path = '/your/api/' + param + '/call'
11requestBody = {
12  'some': 0,
13  'awesome': 1,
14  'data': 3
15}
16request.body = requestBody
17client.API(request, function (response) {
18  console.log(response.statusCode)
19  console.log(response.body)
20  console.log(response.headers)
21})

Usage

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

First, update your environment with your SENDGRID_API_KEY.

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

Here is the full working code.

To run the example:

1node examples/example

Roadmap

If you are interested 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.

• Feature Request
• Bug Reports
• Improvements to the Codebase

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)