Skip to main content

​
Overview

The Link UI is the interface your end users access to authenticate with OEMs and connect their devices to your application. It handles the entire authentication and device registration flow, so you don’t need to implement OEM-specific authentication logic. The Link UI uses the same base URL for both Sandbox and Live environments. The environment is determined by a query parameter. Base URL: 
https://auth.amps.ai/{appId}
Sandbox Environment: 
https://auth.amps.ai/{appId}?sandbox=true
Live Environment: 
https://auth.amps.ai/{appId}
The sandbox query parameter accepts true or 1 to enable sandbox mode. If omitted, the environment defaults to Live.
Replace {appId} with your actual application ID from the dashboard.

Environments Guide

Learn more about Sandbox and Live environments

​
Authentication Flow

1

Device Type Selection

Users first select the type of device they want to connect (e.g., Vehicle, Solar Inverter, Battery, HVAC, etc.)
Link UI step 1: Device type selection screen
2

OEM Selection

Users select which OEM they want to connect (e.g., Tesla, Enphase, Nest, etc.)
Link UI step 2: OEM selection screen
3

Credential Authentication

Users authenticate using one of three methods supported by the OEM:
  • Username/Password: Traditional login credentials
  • API Key: OEM-provided API key
  • OAuth2: OAuth flow for supported OEMs
Link UI step 3: Credential entry screen
4

Multi-Factor Authentication

If required by the OEM, users complete MFA verification
5

Device Selection

Users select which devices they want to connect from their OEM account
6

Consent & Registration

Users grant permissions and devices are registered to your customer account

​
Connection Types

Different OEMs support different authentication methods:
​
username_password
string
Traditional username and password authentication. Users enter their OEM account credentials directly.
​
api_key
string
API key-based authentication. Users provide an API key issued by the OEM.
​
oauth2
string
OAuth 2.0 flow for supported OEMs. Users are redirected to the OEM’s authorization page.

​
Integration Options

Direct Link

Direct users to the Link UI URL. After completion, they’ll be redirected back to your application.

Embedded Flow

Embed the Link UI in an iframe within your application (if supported).

​
What Happens After Connection

Once devices are connected:
  1. Device Registration: Devices are registered to your customer account
  2. Immediate Access: You can immediately query device data via the API
  3. Webhook Notifications: You’ll receive device.connected webhook events
  4. Device Management: Devices appear in your dashboard and can be managed via API

​
Security & Privacy

The Link UI handles all credential storage securely. Credentials are encrypted and stored separately from your application.
  • Credentials are never exposed to your application
  • All authentication happens directly with the OEM
  • Users maintain full control over their device connections
  • Users can disconnect devices at any time

​
Reconnection Flow

Users can reconnect devices using existing credential hashes without re-authenticating, as long as their credentials remain valid with the OEM.
Reconnection occurs when:
  • A user wants to add more devices from the same OEM
  • Credentials need to be refreshed
  • Device connection status needs to be verified
If credentials are no longer valid, users will be prompted to re-authenticate through the full connection flow.

​
Troubleshooting

Ensure the OEM is supported in your environment. Some OEMs may only be available in sandbox or live environments.
Verify that:
  • The OEM credentials are correct
  • MFA is completed if required
  • The OEM account has proper permissions
  • The OEM service is not experiencing outages
Check that:
  • The OEM account has devices registered
  • Device permissions are granted during consent
  • The device type is supported by Amps AI

​
Next Steps

Link UI Customization

Learn about advanced configuration options

API Authentication

Learn how to authenticate your API requests

Webhooks

Set up webhook endpoints

API Reference

Explore the full API documentation