https://github.com/fullcontact/contacts-api-node

Node.js SDK for Contacts+ Contacts API
https://github.com/fullcontact/contacts-api-node

fullcontact node-js sdk

Last synced: 3 months ago
JSON representation

Node.js SDK for Contacts+ Contacts API

• Host: GitHub
• URL: https://github.com/fullcontact/contacts-api-node
• Owner: fullcontact
• License: mit
• Created: 2017-01-31T19:29:45.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-26T20:50:48.000Z (almost 2 years ago)
• Last Synced: 2024-08-31T19:41:11.522Z (5 months ago)
• Topics: fullcontact, node-js, sdk
• Language: JavaScript
• Homepage: https://www.contactsplus.com/developers/contacts-api
• Size: 664 KB
• Stars: 7
• Watchers: 5
• Forks: 3
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/fullcontact/contacts-api-node.svg?branch=master)](https://travis-ci.org/fullcontact/contacts-api-node)

[![npm version](https://badge.fury.io/js/contacts-api-node.svg)](https://badge.fury.io/js/contacts-api-node)

[![Node version](https://img.shields.io/node/v/contacts-api-node.svg?style=flat)](http://nodejs.org/download/)

*IMPORTANT: This SDK should be used server-side only. Using it in a browser would expose Client Secret*

*Looking for FullContact Enrich APIs? there is a new SDK for that: [https://github.com/fullcontact/fullcontact-node-sdk](https://github.com/fullcontact/fullcontact-node-sdk)*

### Installation

`npm install contacts-api-node --save`

### Documentation

API Documentation can be found at [https://www.contactsplus.com/developers/contacts-api](https://www.contactsplus.com/developers/contacts-api)

JSDocs can be found in [docs.md](docs.md)

### Usage

##### Configuration

---

```

var contactsplus = require('contacts-api-node')({

	clientId: '', //for v3 APIs. See: https://app.contactsplus.com/apps

	clientSecret: '',

	redirectUri: '',

	scope: 'list,of,scopes',

	userAgent: ''

});

```

##### OAuth

---

All OAuth methods can be found under the `oauth` property on the client.

###### Supported Methods:

- getAuthorizationUrl()

- exchangeAuthCode(code)

- exchangeRefreshToken(refresh_token)

```

var url = contactsplus.oauth.getAuthorizationUrl();

```

##### Contacts APIs

---

All Contacts APIs can be found under the `contacts` property on the client.

```

contactsplus.contacts.account.get(accessToken)

	.then(res => {

		//2xx response

	})

	.catch(res => {

		//non-2xx response

	});

```

#### Tests

---

To run tests:

`npm test`

To get coverage report:

`npm run coverage`