RD Station Javascript library for API integration

Single lib to allow RDStation integration on Javascript ES2015 projects.

Installation

npm install rdstation

Conversion via API KEY

For the simple conversion you can use the conversion with the api key, with no need to do the authentication process as needed for the others resources.

Conversion with Api Key

import { Conversion } from 'rdstation';

const conversion = new Conversion(apikey);
conversion.send({
    conversion_identifier: 'my_conversion_id',
    email: '[email protected]',
    name: 'Lead Name",
    tags: ['my', 'tags']
    // other fields as specified on documentation
});

Authentication

RDStations states on developer documentation:

Step 1:

Create an app on the RD Station App Store

Step 2:

Replace the URL fields below with the data you will get from the application.

https://api.rd.services/auth/dialog?client_id={client_id}&redirect_url={redirect_url}

Step 3:

Click on the link and log in to RD Station Marketing.

Step 4:

After login and confirmation of access, we will send the code to the callback URL.

Step 5:

Request access_token and refresh_token from the generated code, sending a request to our API.

Passo 6:

Ready! You can now send data to our API with the access_token received.

Features

• Contacts: class to work with RDStation Contact resource (the core Contact central resource)
• Events: class to work with RDStation Event resource (opportunities, ecommerce carts, chats, etc)
• Funnels: class to work with RDStation Funnel resource

Library Resources

Contacts

RDStation Developer documentation:

https://developers.rdstation.com/pt-BR/reference/contacts

import { Authentication, Contact } from 'rdstation';

const clientId = 'Your RDStation app client id';
const clientSecret = 'Your RDStation app client secret';
const authCode = 'Code returned on callback'

const auth = new Authentication(clientId, clientSecret);
const accessToken = auth.getAccessToken(authCode);

const contact = new Contact(accessToken);

// Get by UUID
let response = contact.get('5408c5a3-4711-4f2e-8d0b-13407a3e30f3');

// Get by Email
let response = contact.getByEmail('[email protected]');

// Update a contact (by UUID)
let response = contact.update('5408c5a3-4711-4f2e-8d0b-13407a3e30f3', {
    // fields of request body according to RDStation documentation
});

// Upsert a contact (bt UUID identifier)
let response = contact.upsert('uuid', '5408c5a3-4711-4f2e-8d0b-13407a3e30f3', {
    // fields of request body according to RDStation documentation
});

// Upsert a contact (by email identifier)
let response = contact.upsert('email', '[email protected]', {
    // fields of request body according to RDStation documentation
});

Funnels

RDStation Developer documentation:

https://developers.rdstation.com/pt-BR/reference/contacts/funnels

import { Authentication, Funnel } from 'rdstation';

const clientId = 'Your RDStation app client id';
const clientSecret = 'Your RDStation app client secret';
const authCode = 'Code returned on callback'

const auth = new Authentication(clientId, clientSecret);
const accessToken = auth.getAccessToken(authCode);

const funnel = new Funnel(accessToken);

// Get funnels by UUID
let response = funnel.get('5408c5a3-4711-4f2e-8d0b-13407a3e30f3', 'default');

// Get funnels by Email
let response = funnel.getByEmail('[email protected]', 'default');

// Update funnel by UUID
let response = funnel.update('5408c5a3-4711-4f2e-8d0b-13407a3e30f3', 'default', {
    // request body parameters as documentation
});

// Update funnel by contact email
let response = funnel.update('[email protected]', 'default', {
    // request body parameters as documentation
});

Events

RDStation Developer documentation:

https://developers.rdstation.com/pt-BR/reference/events

import { Authentication, Event } from 'rdstation';

const clientId = 'Your RDStation app client id';
const clientSecret = 'Your RDStation app client secret';
const authCode = 'Code returned on callback'

const auth = new Authentication(clientId, clientSecret);
const accessToken = auth.getAccessToken(authCode);

const event = new Event(accessToken);

// Basic conversions
let response = event.conversion({
    email: 'lead@email',
    name: 'Lead Name',
    tags: ['lead', 'tags']
});

// Opportunity
let response = event.opportunity({
    funnel_name: 'default',
    email: 'lead@email',
});

// Opportunity Won (Sale)
let response = event.opportunityWon({
    funnel_name: 'default',
    email: 'lead@email',
    value: 100.50
});

// Opportuniy lost
let response = event.opportunityLost({
    funnel_name: 'default',
    email: 'lead@email',
    value: 'lost reason'
});

// Order placed (Ecommerce order)
let response = event.orderPlaced({
    name: 'Lead name',
    email: 'lead@email',
    cf_order_id: 'ORDER ID',
    cf_order_payment_amount: 200.00
});

// Order specific item placed
let response = event.orderPlacedItem({
    // ... see fieds on RD Docs
});

// Cart abandoned
let response = event.cartAbandoned({
    // ... se fieds on RD Docs
});

// Cart abandoned item
let response = event.cartAbandonedItem({
    // ... se fieds on RD Docs
});

// Chat started
let response = event->chatStarted({
    // ... se fieds on RD Docs
});

// Chart finished
let response = event->chartFinished({
    // ... se fieds on RD Docs
});

License

MIT License

Copyright (c) 2020 Glauber Portella

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

TODO

• Needs automated tests
• Add other types of resources
• Please help improve