Getting Started


Set up your developer environment and start building contactless solutions using Openscreen's Node.js and python SDKs. Initiate your QR code workflows today!

Ensure that you have completed the following steps prior to using the SDKs:

  • Sign up or sign in to your Openscreen Account.

  • Create a new project

  • Get your authorization and project keys:

    • API Key - You can access your API key on the Openscreen dashboard. This API key is unique to your Openscreen account.

    • API Secret Key - You are given a secret key along with your API key on the Openscreen dashboard. This secret key can only be viewed once and is used to authenticate your account when working with the Openscreen SDK.

    • Project Id - When creating a new project using the Openscreen dashboard, you will be given a projectId that you will use throughout your code to use the Openscreen SDK. This projectId is used to identify your unique Openscreen project.

Create a new folder for your first Openscreen project. We recommend you to use a .env file to store your API credentials.

Select the coding language on the top-right to update the installation instructions.

Node.js SDK


Requirements

You may use dotenv if you wish to use environment variables.

Installation

The easiest way to install the Openscreen's node.js SDK is by using npm. Run the following command from your project directory to install the Openscreen node.js SDK:

Python SDK


Requirements

You may use python-dotenv if you wish to use environment variables.

Installation

The easiest way to install the Openscreen's python SDK is by using pip. Run the following command from your project directory to install the Openscreen python SDK:

1 npm install @openscreen/sdk
1 pip install openscreen

Next Steps