Skip to content

Instantly share code, notes, and snippets.

// create contact in Openscreen
await os.project(process.env.OS_PROJECT_ID).contacts().create({
firstName,
lastName,
emailAddress,
cellPhone,
consent,
})
// add profile to list in Klaviyo
require('dotenv').config()
const { Openscreen } = require('@openscreen/sdk')
// initialize Openscreen SDK
const os = new Openscreen().config({
key: process.env.OS_API_KEY,
secret: process.env.OS_API_SECRET,
})
// script that generates a QR code in the project's /public directory
require('dotenv').config()
const express = require('express')
const path = require('path')
const bodyParser = require('body-parser')
const { Openscreen } = require('@openscreen/sdk')
// initialize Openscreen SDK
const os = new Openscreen().config({
key: process.env.OS_API_KEY,
secret: process.env.OS_API_SECRET,
@birinder-lobana
birinder-lobana / getting_started_with_Openscreen_node_sdk.js
Created May 2, 2022 16:53
Getting started with Openscreen node SDK and create your first dynamic, trackable QR Code
// Run the following code to test that you have successfully created a project and installed the Openscreen SDK.
// Initiate the Openscreen node SDK
const{ Openscreen }=require("@openscreen/sdk");
require('dotenv').config();
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
// Insert the project ID that you received using the Openscreen dashboard
const projectId ='xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
async function main(){
@birinder-lobana
birinder-lobana / initiate_node_sdk.js
Created May 2, 2022 16:57
Use this code to connect to the Openscreen node sdk
const { Openscreen } = require("@openscreen/sdk");
require('dotenv').config();
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
// Input the project ID that you received in the Openscreen dashboard as a string, your project ID should look similar to the one provided below
const projectId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
@birinder-lobana
birinder-lobana / create_dynamic_QR_code.js
Last active December 30, 2022 20:41
Create a new trackable, dynamic QR Code
// Initiate the Openscreen node SDK
const { Openscreen } = require("@openscreen/sdk");
require('dotenv').config();
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
// Obtain ProjectID from Openscreen Dashboard
const projectId = 'YOUR PROJECT ID';
async function main() {
// Create an asset for a new listing sign being hosted for 123 Main Street
// Initiate the Openscreen node SDK and include the project ID that you recieved using the Openscreen dashboard
const { Openscreen } = require("@openscreen/sdk");
require('dotenv').config();
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
const projectId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
async function main() {
// Create an asset and generate a Static QR Code
const res = await os.project(projectId).assets().create({
@birinder-lobana
birinder-lobana / scan_object.json
Last active July 13, 2022 19:04
A Scan object like this one is generated after each dynamic QR code scan
{
"entityType": "get_scans_by_asset_id.response_body",
"assetId": "0a43a07c-0e57-4879-9420-332a13174458",
"numberOfScans": 1,
"scans": [
{
"entityType": "app.scan",
"created": "2021-10-07T18:38:06.616Z",
"modified": "2021-10-07T18:38:06.616Z",
"assetId": "0a43a07c-0e57-4879-9420-332a13174458",
@birinder-lobana
birinder-lobana / add_contacts_to_Openscreen.js
Last active September 8, 2022 14:27
Use this code to create contacts upon scanning a dynamic QR code.
// Initiate the Openscreen node SDK and include the project ID that you received using the Openscreen dashboard
const { Openscreen } = require("@openscreen/sdk");
require('dotenv').config();
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
const projectId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
async function main(){
// Create a new contact
@birinder-lobana
birinder-lobana / contact.json
Last active June 28, 2022 16:47
The contact object which can be pre-loaded in Openscreen database or captured after a dynamic QR code is scanned and redirected to a web-form.
"contact": {
"contactId": "864422e9-0741-43e6-8b73-b46ea0c0cc16",
"firstName": "Brian",
"lastName": "Smith",
"emailAddress": "bsmith@test.com",
"mailingAddress": {
"address": "123 Street",
"city": "Toronto",
"provinceOrState": "ON",
"country": "Canada",