Authentication
After you have installed the Openscreen SDK, you can start calling the SDK endpoints. To start, ensure that your API credentials are stored in a .env
file. Use the following code to initiate connection with the Openscreen SDK:
1
2
3
4
5
6
7
8
const { Openscreen } = require("@openscreen/sdk");
require('dotenv').config();
#Obtain your access_key and secret by logging into your Openscreen dashboard
const os = new Openscreen().config({
key: process.env.OS_API_KEY,
secret: process.env.OS_API_SECRET
});
1
2
3
4
5
6
7
import openscreen
from dotenv import dotenv_values
config = dotenv_values('.env')
#Obtain your access_key and secret by logging into your Openscreen dashboard
ospro = openscreen.Openscreen(access_key=config.get("OS_API_KEY"), access_secret=config.get("OS_API_SECRET"))
You now have access to Openscreen's library of SDK endpoints. To begin creating QR Code enabled workflows, check out how to create a Dynamic QR Code.
Once you have your first Dynamic QR code, the following topics will help you create a complete workflow:
Create Dynamic Batch QR Codes
Obtain and retrieve scan data
Create a Contact upon a QR Code Scan
Create an SMS template and Send SMS.
Openscreen SDKs are built with developer freedom in mind, as such, you may customize the workflows to suit your needs. However, it is your responsibility to ensure privacy guidelines are followed. For any questions with the use of Openscreen SDKs, please feel free to contact us.