Skip to content

Perception API web client

Introduction

This section describes the web client provided for interfacing with Sense Aeronautics' Video Processing REST API. This web client provides access to all the basic functionalities of the Video Processing API and video visualization for an API KEY in an user-friendly manner.

Further integration and access to all the funcionalities of the REST API can be done programatically using the same KEY against the API, as described in the documentation:

In detail documentation about the REST API can be found at https://docs.senseaeronautics.com/

The web client is available at https://front.senseaeronautics.com.

Login

When users open the web client and are not logged in, they land on the Login screen.

This page introduces SenseWeb and provides the login form used to authenticate against the SenseAPI using an API key. From here users can also find links to product pages, API docs and the API key request form.

Quick start — How to log in

Login screen

  1. Obtain an API key. If you don't have one, request it via the provided link on the landing page or here. This key identifies you as a user, and ensures you have access to the Video Analysis system with your configuration. The key can also be used for interacting with the REST API programatically.

  2. Enter your API key in the API Key field.

  3. Select your environment:

  4. Production (PROD) — use when connecting to production services.

  5. Staging (STG) — use for testing and evaluation against staging services.

  6. Click Login. On success, you are redirected to the main application (/home). Here you can view your sources and start interacting with the Video Processing system.

When logged in, the top navigation becomes available and your account avatar appears in the top-right tools area.

Navigation menu

The header shows the following navigation links:

  • HOME → Lists the sources belonging to the current user.
  • VISUALIZATION → Displays processed sources.
  • REPORTS → Lists processed-source reports that can be viewed.

User menu

User menu

The user avatar opens a popover showing:

  • Username
  • API version (link to API changelog/docs)
  • Web client version (link to Web changelog/docs)
  • Product type, subscription expiration date and remaining minutes of use for the current account.
  • Accounts selector to switch between saved API keys or add a new one.
  • Logout button.

Adding multiple accounts

Once you are logged in, the user menu provides the option to add more accounts using the Accounts selector and different API keys.

  1. Open the selector and click on --Add new-- option. Add more accounts

  2. A dialog appears where you can add a new account. Enter an API key and select the environment. New account dialog

  3. On success, the new username appears in the Accounts selector. Click it to switch between accounts.

Switch account