SDK Getting Started

Summary

Getting started with SDK (Software Development Kit) helps you to install Wirewheel NPM (Node Package Manager). Before you get started, you'll need to understand how to create a client consent object and how to create consents.

As an example, refer to the following:

• Vue example
• NodeJS example

Here are two sample programs:

• Vue Sample
• Node JS Sample

What You'll Learn

In this article, you'll learn:

• How to install Wiresheel npm
• An alternate way to create a Consent

👍

Prerequistes

You will need to:

• Create a brand and channel and create a clientId, clientSecret, and issuerURL
• Have a good understanding about oAuth2 to request a bearerToken
• Pick a scope

Install NPM SDK

Install the NPM SDK with:

npm install @wirewheelio/cmp-javascript-sdk

Important Notes

📘

Note on BearerToken

The SDK is a wrapper around the API. This means it requires the same oAuth2 bearerToken, just like the REST API.

oAuth2 is explained here.

📘

A Note on TypeScript

The SDK is written in TypeScript. TypeScript is just an extension of JavaScript that adds classes, constructors, etc. You do not need to know TypeScript, because JavaScript can use TypeScript objects. You only need to import the SDK, like this:

import { WireWheelSDK, CreateConsentPayloadBuilder, Subject } from '@wirewheelio/cmp-javascript-sdk'

📘

A Note on SDK Version

You will probably need to change the version number of @wirewheelio/cmp-javascript-sdk to match the latest one here on npm.

---

Didn’t find what you were looking for?

Email our team: [email protected]?subject=UPCP