ANTE User Manual

Device Management (Facial Recognition API)

The Device Management screen is where you register the facial-recognition terminals that connect to ANTE for time tracking. Each device you add gets its own API key — the secret that lets that terminal talk to ANTE to clock employees in and out, enroll faces, and read attendance data.

You manage devices here: see all registered terminals, add new ones, edit their details, deactivate them, and regenerate their keys. A companion API Documentation screen lists the connection details a technician needs when setting up a device.

Accessing Device Management

  1. Open Manpower in the sidebar.
  2. Go to API → Devices.

The page header reads Device Management with the subtitle "Manage devices that can access the facial recognition time tracking API."

The Device List

The list shows one row per registered device with these columns:

  • Device Name — the name you gave the terminal.
  • Device ID — the system-generated identifier for the device.
  • Location — where the device is installed (shows a dash if none was entered).
  • Branch — the branch the device belongs to, if assigned (shows a dash if none).
  • Status — a colored badge: Active or Inactive.
  • Last Activity — when the device last contacted ANTE.
  • Created — the date the device was registered (hidden by default; enable it from the column controls).

Click any row to open that device's detail page.

Use the search box and pick what to search by:

  • All Fields (default)
  • Name
  • Device ID
  • Location

Filters

  • Status — Active or Inactive.

Toolbar action

At the top right of the list:

  • Add Device — opens the Add Device page.

If no devices exist yet, the table shows "No devices found."

Adding a Device

Click Add Device to open the Add Device page. The page is titled Add Device with the subtitle "Create a new facial recognition time tracking device."

Under the Device Information section, fill in:

  • Device Name * — the terminal's name. A required field. Example placeholders: "Entrance Terminal, Main Gate."
  • Location — an optional description of where the device is installed.
  • Branch — choose which branch the device belongs to. Leave it on No branch (company-wide) to make the device available across the whole company.

Click Add Device to save (the button shows "Creating..." while it works).

Save the API key immediately

As soon as the device is created, a Save API Key dialog appears showing the new key. This API key will only be shown once. Use Copy & Close to copy it to your clipboard, hand it to whoever is configuring the terminal, then click I have saved the key. If you lose it, you must regenerate the key (see below).

If you leave Device Name blank, the form shows "Device name is required" and a "Please fill in all required fields" message.

Viewing a Device

Click a device row to open its detail page. The header shows the device name and its Device ID, and the page is split into two sections:

Device Information

  • Device Name
  • Device ID
  • Location (dash if none)
  • Branch (dash if none)
  • Status — Active or Inactive badge
  • Last Activity — the last time the device contacted ANTE, or Never if it hasn't yet

API Key

This section carries a reminder: "API keys are only visible at creation or regeneration time. Use the Regenerate Key button to generate a new one." The key itself is never shown again after creation.

Detail page actions

At the top right of the detail page:

  • Edit Device — open the Edit Device page.
  • Regenerate API Key — issue a brand-new key for this device.
  • Deactivate — soft-disable the device (only shown while the device is Active).

Editing a Device

From the detail page, click Edit Device. The Edit Device page repeats the Device Information section with the same fields as Add, plus one more:

  • Device Name * (required)
  • Location
  • Branch (or No branch (company-wide))
  • Active — a checkbox to turn the device on or off

Click Save Changes to apply your edits (the button shows "Saving..." while it works).

Common Tasks

Registering a new terminal

Step 1 — Go to Manpower → API → Devices.

Step 2 — Click Add Device.

Step 3 — Enter a Device Name, and optionally a Location and Branch.

Step 4 — Click Add Device.

Step 5 — In the Save API Key dialog, click Copy & Close, store the key somewhere safe, then click I have saved the key. Give this key to the person setting up the terminal.

Regenerating an API key

Regenerate a key if the old one was lost or may have been exposed.

Step 1 — Open the device from the list.

Step 2 — Click Regenerate API Key.

Step 3 — Confirm in the Regenerate API Key dialog. It warns: "The current key will be invalidated and all connected devices will need to be updated."

Step 4 — A New API Key Generated dialog shows the new key. Click Copy & Close to save it.

Warning

Regenerating immediately invalidates the old key. Any terminal still using the old key stops working until it is updated with the new one.

Deactivating a device

Step 1 — Open the device from the list.

Step 2 — Click Deactivate.

Step 3 — Confirm in the Deactivate Device dialog. It warns: "It will no longer be able to access the API."

A deactivated device shows an Inactive status badge. You can turn it back on later by editing the device and ticking the Active checkbox.

API Documentation

Under Manpower → API, the Documentation screen is a self-contained reference for technicians connecting a terminal to ANTE. It is titled API Documentation with the subtitle "Reference guide for the facial recognition device API."

You don't need this screen for normal day-to-day use — it's for whoever installs and configures the physical devices. It lays out:

  • Authentication — most endpoints require the device's API key, passed in an x-api-key header. The key is the one you obtained when creating the device.
  • Endpoint groups — the available device operations, organized into Health & Status, Employee Management, Time Tracking, Face Enrollment & Recognition, and Device Settings. Each entry shows the request type, the address, and a short description; a key icon marks the ones that require the API key. A copy button next to each one copies a ready-to-run example.
  • Base URL — the address the device connects to.
Tip

The Time Tracking group covers the everyday clock actions — a smart clock that automatically records a time-in or time-out, explicit time-in and time-out, daily logs, currently clocked-in employees, and weekly attendance summaries. The Face Enrollment & Recognition group covers enrolling an employee's face and matching a face at the terminal.

← Previous
Face Scan Logs
Next →
Setting Up Payroll