node-mm-rest-api

Node.js wrapper for the Oracle Maxymiser REST API.

Table Of Contents

• Install
• Instantiate
• Site Settings
  • Read Sites
  • Read Site Scripts
  • Update Site Script
  • Read Site Actions
• Campaign Settings
  • Read Campaigns
  • Create Campaign
  • Read Elements
  • Create Element
  • Read Variants
  • Create Variant
  • Update Variant
  • Read Campaign Scripts
  • Create Campaign Script
  • Update Campaign Script
  • Read Campaign Actions
  • Update Campaign Action
• Publishing

Install

HTTPS:

npm i git+https://git@github.com/leanconvert/node-mm-rest-api.git --save

SSH:

npm i git+ssh://git@github.com/leanconvert/node-mm-rest-api.git --save

Instantiate

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/OAuth2.html

const MMRestApi = require('node-mm-rest-api');
const api = MMRestApi({
  // default values:
  // authHost: 'https://api-auth-eu.maxymiser.com/oauth2',
  // host: 'https://api-eu.maxymiser.com',
  // apiVersion: 1,
  credentials: {
    clientId: '<clientId>',
    clientSecret: '<clientSecret>',
    username: '<login for UI>',
    password: '<password for UI>'
  }
});

Site Settings

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/api-Site%20Settings.html

Read Sites

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-get.html

Get all sites

api.sites.get()
  .then(sites => {
    console.log(sites);
  });

Get site by ID

api.sites.get({siteId: 'MzIxMzM'})
  .then(site => {
    console.log(site);
  });

Get site by Name

api.sites.get({siteName: 'test.com'})
  .then(site => {
    console.log(site);
  });

Read Site Scripts

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-scripts-get.html

Get all scripts by Site ID

api.sites.scripts.get({siteId: 'MzIxMzM'})
  .then(scripts => {
    console.log(scripts);
  });

Get all scripts by Site Name

api.sites.scripts.get({siteName: 'test.com'})
  .then(scripts => {
    console.log(scripts);
  });

Update Site Script

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-scripts-%7Bscript-id%7D-put.html

Update Script by Name

api.sites.scripts.update({
  siteId: 'MzIxMzM',
  // siteName: 'test.com',
  scriptName: 'renderer'
})
.then(result => {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Update Script by ID

api.sites.scripts.update({
  siteId: 'MzIxMzM',
  // siteName: 'test.com',
  scriptId: 'Mzas3zM'
})
.then(result => {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Read Site Actions

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-elements-%7Belement-id%7D-variants-%7Bvariant-id%7D-put.html

Read all actions

api.sites.actions.update({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
})
.then(actions => {
  console.log(actions);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Campaign Settings

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/api-Campaign%20Settings.html

Read Campaigns

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-get.html

api.campaigns.get({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
}).then(campaigns => {
  console.log(campaigns);
})

Create Campaign

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-post.html

api.campaigns.create({
  siteId: 'MzIxMzM',
  // siteName: 'test.com',
  name: 'My campaign',
  desciption: ''
}).then(result => {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Read Elements

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-campaigns-%7Bcampaign-id%7D-elements-get.html

api.campaigns.elements.get({
  siteName: 'test.com',
  // siteId: 'MzIxMzM',
  campaignName: 'a31-test',
  // campaignId: 'MzIsdfMzM',
}).then(elements => {
  console.log(elements);
})

Create Element

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-campaigns-%7Bcampaign-id%7D-elements-post.html

api.campaigns.elements.create({
  siteName: 'test.com',
  // siteId: 'MzIxMzM',
  campaignName: 'a31-test',
  // campaignId: 'MzIsdfMzM',
  name: 'Element1',
  description: ''
}).then(result => {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Read Variants

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-campaigns-%7Bcampaign-id%7D-elements-%7Belement-id%7D-variants-get.html

api.campaigns.variants.get({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4'
}).then(variants => {
  console.log(variants);
});

Create Variant

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-elements-%7Belement-id%7D-variants-post.html

api.campaigns.variants.create({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4',
  name: 'Variant2',
  content: '<span>Search</search>',
  isDefault: false,
  isControl: true,
  weight: 100
}).then(result {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Update Variant

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-elements-%7Belement-id%7D-variants-%7Bvariant-id%7D-put.html

api.campaigns.variants.update({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4',
  variantId: 'KHFed4',
  name: 'Variant2',
  content: '<span>Search</search>',
  isDefault: false,
  isControl: true,
  weight: 100
}).then(result {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Read Campaign Scripts

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-campaigns-%7Bcampaign-id%7D-scripts-get.html

api.campaigns.scripts.get({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4'
}).then(scripts => {
  console.log(scripts);
});

Create Campaign Script

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-%7Bconfiguration%7D-campaigns-%7Bcampaign-id%7D-scripts-post.html

api.campaigns.scripts.create({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4',
  name: 'renderer',
  description: '',
  content: 'console.log("test")';
}).then(result {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Update Campaign Script

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-scripts-%7Bscript-id%7D-put.html

api.campaigns.scripts.update({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4',
  scriptId: 'asdfASD3',
  name: 'Rendering',
  description: '',
  content: 'console.log("test")';
}).then(result {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Read Campaign Actions

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-actions-get.html

api.campaigns.actions.get({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4'
}).then(actions => {
  console.log(actions);
});

Update Campaign Action

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-campaigns-%7Bcampaign-id%7D-actions-%7Baction-id%7D-put.html

api.campaigns.scripts.update({
  siteName: 'test.com',
  campaignName: 'a31-test',
  elementName: 'renderer',
  // siteId: 'MzIxMzM',
  // campaignId: 'MDA2MjYx',
  // elementId: 'MDMyMDU4',
  actionsId: 'NDMyNDMy',
  name: 'Action1',
  description: 'My first action',
  type: 'ClickCounts',
  isPrimary: 'true'
}).then(result {
  console.log(result);
});

api.publish({
  siteId: 'MzIxMzM',
  // siteName: 'test.com'
});

Publishing

Every time you create/update Site or Campaign object using the Oracle Maxymiser REST API the data is only being stored in the database. To apply the data to the Sandbox you need to make a publish request in addition.

http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCGF/op-sites-%7Bsite-id%7D-sandbox-publish-put.html

api.publish({
  siteName: 'test.com'
  // siteId: 'MzIxMzM'
})
.then(() => {
  console.log('Published!');
})