Exciting news!Announcing our $4.6M Series Seed. Learn more
Socket
LoveBlogFAQ
Install
Log in

@openscreen/sdk

Package Overview
Dependencies
4
Maintainers
1
Versions
18
Issues
File Explorer

Advanced tools

@openscreen/sdk

Generate Unique, Dynamic and trackable QR Codes at scale with Openscreen SDK

    0.8.2latest

Version published
Maintainers
1
Yearly downloads
3,045

Weekly downloads

Readme

Source

Openscreen Node SDK

Openscreen is a software developer platform that allows users to easily generate unique and trackable QR Codes at scale using our Node SDK.

Additional information on using the Node SDK can be found in our developer documentation.

Requirements

If you don't already have an Openscreen account, you can sign up for a free account here.

Installation / Usage

npm install @openscreen/sdk # or using Yarn yarn add @openscreen/sdk

CommonJS

const {Openscreen} = require('@openscreen/sdk')

ES6 & TypeScript

import {Openscreen} from '@openscreen/sdk'

Getting Started

Openscreen authenticates your API requests using your account's API key and API secret key. You will also need the ID of the project you wish to work with. Your API key, secret key and project ID can all be found in your by logging into your Openscreen dashboard. The following examples demonstrates how to use these values in the SDK to generate your first QR code.

const {Openscreen} = require('@openscreen/sdk') const PROJECT_ID = '**PROJECT_ID**' const os = new Openscreen().config({ key: '**KEY**', secret: '**SECRET**', }) async function myFirstQRCode(event) { const res = await os .project(PROJECT_ID) .assets() .create({ name: 'Openscreen website', description: 'Dynamic QR code to https://openscreen.com', qrCodes: [ { intent: 'https://openscreen.com', intentType: 'DYNAMIC_REDIRECT', }, ], }) const {qrCodeId} = res.asset.qrCodes[0] const qrCode = await os.qrCode(qrCodeId).get({format: 'PNG', dataUrl: true}) await os.saveQrImageDataToFile(qrCode, 'my-first-qr.png') } myFirstQRCode().catch(console.error)

Keywords

FAQs

What is @openscreen/sdk?

Generate Unique, Dynamic and trackable QR Codes at scale with Openscreen SDK

Is @openscreen/sdk popular?

The npm package @openscreen/sdk receives a total of 95 weekly downloads. As such, @openscreen/sdk popularity was classified as not popular.

Is @openscreen/sdk well maintained?

We found that @openscreen/sdk demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 25 May 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc