# sendgrid-rest
> HTTP REST client, simplified for Node.js.
Latest version **2.6.1** (published 2020-03-18) · MIT license · 0 weekly downloads
## Install
```sh
npm install sendgrid-rest
pnpm add sendgrid-rest
yarn add sendgrid-rest
bun add sendgrid-rest
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 2.6.1 |
| Published | 2020-03-18 |
| First published | 2016-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10 |
| Dependencies | 2 |
| Unpacked size | 65.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | SendGrid |
| Maintainers | thinkingserious, twilio-ci |
## Links
- npm: https://www.npmjs.com/package/sendgrid-rest
- Repository: https://github.com/sendgrid/nodejs-http-client
- Homepage: https://sendgrid.com
- Issues: https://github.com/sendgrid/nodejs-http-client/issues
- npm.io page: https://npm.io/package/sendgrid-rest
## Dependencies (2)
- [dotenv](https://npm.io/package/dotenv.md) ^4.0.0
- [core-js](https://npm.io/package/core-js.md) ^3.5.0
## Recent versions
- 2.6.1 (latest) — 2020-03-18
- 2.6.0 — 2020-02-19
- 2.5.2 — 2020-01-22
- 2.5.1 — 2020-01-15
- 2.5.0 — 2019-12-20
- 2.4.0 — 2017-07-14
- 2.3.0 — 2016-10-12
- 2.2.2 — 2016-09-27
- 2.2.1 — 2016-06-15
- 2.2.0 — 2016-06-11
- 2.1.0 — 2016-06-08
- 2.0.0 — 2016-06-06
- 1.0.1 — 2016-04-08
- 1.0.0 — 2016-04-08
## README
[](https://travis-ci.org/sendgrid/nodejs-http-client)
[](https://dx.sendgrid.com/newsletter/nodejs)
[](https://www.npmjs.com/package/sendgrid-rest)
[](https://twitter.com/sendgrid)
[](https://github.com/sendgrid/nodejs-http-client/graphs/contributors)
[](./LICENSE.md)
**Quickly and easily access any RESTful or RESTful-like API.**
If you are looking for the SendGrid API client library, please see [this repo](https://github.com/sendgrid/sendgrid-nodejs).
# Announcements
All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/nodejs-http-client/blob/master/CHANGELOG.md).
# Table of Contents
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Usage](#usage)
- [Roadmap](#roadmap)
- [How to Contribute](#contribute)
- [About](#about)
- [License](#license)
# Installation
## Prerequisites
- Node.js version 0.10, 0.12 or 4
You need to have a API key to use the app. To configure the API key in the environment variables follow these steps.
- create .env file in the root directory of the project.
- Copy the contents of .env_sample file in to the .env file
- Once you have obtained the API key, find the environment variable SENDGRID_API_KEY and assign your API key as it's value.
As an example it should look like this
```
SENDGRID_API_KEY='';
```
## Install Package
```bash
npm install sendgrid-rest
```
# Quick Start
`GET /your/api/{param}/call`
```javascript
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.
```javascript
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](https://sendgrid.com/free?source=nodejs-http-client).
First, update your environment with your [SENDGRID_API_KEY](https://app.sendgrid.com/settings/api_keys).
You can copy the .env_example file located in the "examples" folder to ```.env``` in your project's root.
```cp examples/.env_sample .env```
Once you have edited the file and added your API Key, you can add the variable to your environment:
```source .env```
Here is the [full working code](https://github.com/sendgrid/nodejs-http-client/blob/master/examples/example.js).
To run the example:
```bash
node examples/example
```
=======
[Library Usage Documentation](https://github.com/sendgrid/nodejs-http-client/blob/master/USAGE.md)
# Tests
Tests can be run through a [Docker](https://www.docker.com) container which is defined in the [docker-compose.yml](docker-compose.yml) file.
To run the tests, simply run `docker-compose up`.
# Roadmap
If you are interested in the future direction of this project, please take a look at our [milestones](https://github.com/sendgrid/nodejs-http-client/milestones). We would love to hear your feedback.
# How to Contribute
We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md) guide for details.
* [Feature Request](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#feature-request)
* [Bug Reports](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report)
* [Improvements to the Codebase](https://github.com/sendgrid/nodejs-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase)
# About
nodejs-http-client is guided and supported by the SendGrid [Developer Experience Team](mailto:dx@sendgrid.com).
nodejs-http-client is maintained and funded by SendGrid, Inc. The names and logos for nodejs-http-client are trademarks of SendGrid, Inc.
# License
[The MIT License (MIT)](LICENSE.md)
---
_Source: https://npm.io/package/sendgrid-rest · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._