decipher-api-client v1.1.1

decipher

A simple async client for the Decipher API

Installation

npm install --save decipher-api-client

Getting Started

1. Import your module
2. Initialize module with your API_KEY(Mandatory) and headers(Optional)
3. Send your request

const decipher = require('decipher-api-client')

decipher.initialize({api_key:'YOUR_API_KEY',headers:{'OPTIONAL HEADERS'}})

decipher.get().users()

API

List of Implemented API endpoints

GET

surveyData(surveyID required,params optional)

decipher.get().surveyData('12/123',{format:'json',fields:'email,ipAddress',cond:'qualified'})

users(params optional)

decipher.get().users()

companies()

decipher.get().companies()

companySurveys(companyID optional Defaults to 'all')

decipher.get().companySurveys()

POST

bounced(params required) -can pass in as an array of emails 'email1,email2' or object {emails:'email1,email2'}

decipher.post().bounced({emails:['email1,email2']})

PUT

TBD

DELETE

TBD

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning.