API Keys

Every API request must include a valid API key as a Bearer token in the Authorization header.

Using your API key

SDK

import { UpvioApiClient } from '@upvio/sdk-node'

const client = new UpvioApiClient({
  apiKey: process.env.UPVIO_API_KEY,
  businessId: process.env.UPVIO_BUSINESS_ID,
})

cURL

curl https://api.upvio.com/v1/businesses/{businessId}/vitals/links \
  -H "Authorization: Bearer YOUR_API_KEY"

Creating an API key

1. Go to Settings > Developers > API Keys.

2. Click API Key (or New API Key if you have no keys yet).

3. Enter a Description (e.g., “Production server”) and select an Expiry.

4. Click Create, then Copy value. Copy the key immediately — it is only displayed once.

Note

The Developers section is only visible to users with the Developer role. If you don’t see it, ask a workspace admin for developer access.

Caution

If you lose your API key, you cannot retrieve it. Create a new one and revoke the old key from the same page.

Revoking a key

Open the actions menu next to any active key on the API Keys page and select Revoke. Revoked keys are immediately rejected by the API and show as Invalidated in the list.

Finding your credentials

• Business ID — shown on the API Keys page (Settings > Developers > API Keys) under the heading, after “This business ID is”. Required in all API URLs.
• Business Alias — the Business Alias field on the Business Profile page (Settings > Business Profile). Used to construct scan URLs: https://{alias}.clients.upvio.com/vitals/links/{slug}.

Store these in environment variables:

UPVIO_API_KEY=your-api-key
UPVIO_BUSINESS_ID=your-business-id
UPVIO_BUSINESS_ALIAS=your-business-alias

Keep your key secret

Never expose your API key in client-side code, public repositories, or browser requests. Make all API calls from your server or serverless functions. Rotate keys regularly and use short expiries for development.