Salesflare / fullcontact-node-sdk

Node.js SDK for FullContact Enrich APIs

Home Page:https://www.fullcontact.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status npm version Node version

IMPORTANT: This SDK should be used server-side only. Using it in a browser would expose your API Key.

Installation

npm install fullcontact-node-sdk --save

Documentation

API Documentation can be found at https://docs.fullcontact.com/

JSDocs can be found in docs.md

Usage

Configuration

var fullcontact = require('fullcontact-node-sdk')({
	apiKey: '<API Key>',
	userAgent: '<AppName/Version>',
  returnFullResponse: true | false // Optional: when true, will return the full HTTP response, when false just the body. Defaults to false
});
Enrich APIs

All Enrich APIs can be found under the enrich property on the client.

const myLookup = async () => {
    try {
      const res = await fullcontact.enrich.person.enrich({ email: 'bart@fullcontact.com' })

      //do something with res
    } catch(e) {
      //handle error
    }
}

Tests


To run tests:

npm test

About

Node.js SDK for FullContact Enrich APIs

https://www.fullcontact.com

License:MIT License


Languages

Language:JavaScript 100.0%