aprimo-auth v2.1.0

What is this?

Implement Aprimo Authentication easily in your web application.

Installation

npm i aprimo-auth --save

Then...

import Aprimo from 'aprimo-auth'

// Initialize Aprimo object.
var aprimo = new Aprimo({
  subdomain: "<subdomain>",
  clientid: "<client id>",
  secret: "<client secret>",
  redirecturi: "<redirect URL>",
  relativeAppRedirect: "/",
  silentRefreshInterval: 10,
  authMode: "iframe",
});

// For simple connection without getting the token. This will contain the code session storage which you can use to get the token. You can visit this page and follow step 3 to get your token https://developers.aprimo.com/marketing-operations/rest-api/authorization/#module6
// You can get the codeVerifier in the session storage "codeVerifier"
// You can get the generated aprimo code in the session storage "code" and use it to get a token for your backend.
aprimo.connect()

// Aprimo Authentication using redirects. This will also get the access token from aprimo
aprimo.authenticate()

// Aprimo Reauthentication using hidden iframe or popup window
aprimo.reauthenticate()

// To get the token you should assign a function in the onGetToken event handler. This event handler will be called everytime a new token is fetched
aprimo.onGetToken((event) => {
  // Do your logic here
  // Users can access the aprimo token using event.data
});

// Aprimo Axios Wrapper. Authorization token will be included in the request automatically
aprimo.get(url, data)
aprimo.put(url, payload, data)
aprimo.post(url, payload, data)
aprimo.delete(url, data)

Events

• onGetToken - This event gets triggered every time a new token is fetched using the iframe or popup method

Options

Aprimo Authentication parameters:

• subdomain - required aprimo client subdomain
• clientid - required aprimo registration client id
• secret - required aprimo registration client secret
• redirecturi - required aprimo registration redirect uri. This Uri should handle callbacks from aprimo.
• relativeAppRedirect - optional relative path of the application url. The value placed here will be the url after the authorization is resolved. Take note that this will not trigger a page reload. default Default value is "/"
• silentRefreshInterval - optional Interval in minutes to get a new token. default Default value is 10 minutes.
• authMode - optional possible values is only iframe or popup. The iframe will open a hidden iframe in your page to get new tokens while the popup will open a new window temporarily to get a new token. Please choose the appropriate mode that fits your requirements. default Default value is iframe

Aprimo Setup

Follow these steps to create a new Integration registration inside Aprimo

• Login to Aprimo and Create a new Integration registration. Administration > Integration > Registrations
• Set the OAuth Flow Type to Authorization Code with PKCE
• Take note of the generated Client ID