Skip to main content

Quick Start

This guide shows how to set up the BioStar Air demo site, connect and register compatible devices, and test cloud API integration. If you have worked with BioStar 2 before, many concepts will feel familiar. BioStar Air is fully cloud-based.

Prerequisites​

Before you start, check the following.

  • Prepare a BioStar Air-compatible device with factory-initialized firmware.

    • XP2-AIR, XS2-AIR, BEW3-AIR, BS3-AIR, BLN2-AIR

    • Devices can be purchased through authorized Suprema distributors.

  • The device must be connected to the internet via Ethernet.

  • Allow outbound access on the network.

    • Port 443 (HTTPS)

    • Port 5671 (MQTT over TLS)

Set up the demo environment and API key​

Sign up and log in​

  1. Go to BioStar Air Developer.

  2. Click Sign Up, complete the form, and wait for approval.

  3. After approval, log in using your Developer Portal user email address and password.

Info

The email address and password used for the Developer Portal cannot be used on the Demo Portal.

Create a demo application​

  1. Go to API → Management.

  2. Click + Register.

  3. Select Demo as the application type.

  4. Enter an application name and click Register.

  5. After registering the demo application, you can download the site_info.csv file.

Info

  • The site_info.csv file contains the alias email and password.

  • When logging in to the demo portal, be sure to use this alias email and password.

  • Do not use the email and password for the Developer Portal on the demo portal.

Generate an API key​

  1. Go to API → Management.

  2. Click the application you registered.

  3. Scroll to API Management.

  4. Click Add.

  5. Enter a name and confirm.

  6. Copy the generated API key and store it securely.

This API key is used to authenticate API calls to the demo environment.

Log in to the demo portal​

  1. Click Demo Portal in the Developer Portal menu or go directly to https://demo.airfobspace.com/login.

  2. Log in with the alias email and password from the site_info.csv file.

Info

Do not use the email and password for the Developer Portal on the demo portal.

Register devices​

Use the BioStar Air Demo App (Android only) on your mobile device.

  1. Go to the BioStar Air Developers link and download the demo app.

  2. Launch the demo app and log in with the alias email and password from the site_info.csv file.

  3. Move your Android device near the reader (within BLE range).

    • In All Menu → Devices, tap the button in the upper right.

    • Search for the device and tap Register.

  4. The device beeps, reboots, and appears in the registered device list.

Info

Devices can only be registered through the mobile app. You cannot register devices from the web portal. API-based registration requires an encryption certificate that is not provided to partners.

Device Management​

Manage devices from the demo app or the demo web portal.

Demo vs production​

  • A Demo site for testing is created through the Developer Portal.

  • A Production site is created through the Partner Portal and requires a site ID, user email, and password. Only authorized resellers or Suprema branches can create a production site.

Info

  • User IDs and account IDs are different. Do not confuse them.

  • If you manage multiple sites, store passwords securely.

  • Always use the latest Bearer token.

  • A Bearer token copied from the browser can be reused in Postman.

Need help?​

Open a ticket in the Suprema Technical Support Portal. https://support.supremainc.com

Was this page helpful?