sare-rest-js v0.0.2

SARE API - JavaScript Client

Installation

yarn add sare-rest-js # or npm i sare-rest-js

const { SareClient } = require('sare-rest-js')
// or
import { SareClient } from 'sare-rest-js'

or include from cdn:

<script src="https://cdn.sareapps.pl/sare-rest.min.js">

Methods

• addOrUpdateEmail(payload: AddEmailDTO): Promise<any>
  • Adds/Updates email and props to SARE account
• getEmailData(email: string): Promise<any>
  • Retrieve email data from db

Documentation

• https://yasionfire.github.io/sare-rest-js/

Usage

// create SareClient instance
const sareClient = new SareClient({
  apiKey: 'b462eef0-d84d-11eb-b8bc-0242ac130003', // your API KEY
  uid: '12345', // your SARE User ID
  // optional
  // uri: 'https://s.enewsletter.pl/api/v1/'
})

// get lead data from db
sareClient.getEmailData('test@example.com')
  .then(data => {
    console.log(data)
  })
  .catch(err => {
    console.error(err)
  })


// add/update leads with data
sareClient.addOrUpdateEmail({
    emails: [{
      email: 'test@example.com',
      status: 8,
      mail_type: ["HTML", 'text'],
      groups: [1,21,341]
    }]
  })
  .then(data => {
    console.log(data)
  })
  .catch(err => {
    console.error(err)
  })

Resources

• Knowledge base
• Documentation

See more at sare.pl