Learn how to generate API keys and authenticate with the Vrio API, including setup, header requirements, and access restrictions.
Vrio API vs. Legacy API (formerly Sublytics API)
Vrio API key is required for access by vendors or your organization that uses the endpoint:
api.vrio.appLegacy API key is required for access by vendors or your organization that uses the endpoint:
[subdomain].vrio.appOR[subdomain.sublytics.com].Both APIs are available to Vrio and Sublytics customers.
API Reference
- Vrio API Docs are located here.
- Be sure to check out our API recipes to streamline launch.
The legacy Sublytics API will be decommissioned by Jan 1st, 2027
Generate the Vrio API Key
-
Select Settings in the top navigation
-
Navigate to the Permissions tab
-
Select Users:
-
Click Add User:
-
Choose: Vrio API
-
Select Group:
Groups are used to restrict the User Type. Learn more about User Groups.
Choose a group that gives the API key access to only what the integration needs. Admin gives the API key unrestricted access, including creating other users. -
Click Submit.
You will be taken to the new user's page, where the API key is shown in a warning at the top.
Click the copy icon next to the key and store it somewhere secure.
The full API key is only shown once, right after the user is created.
After you leave that page, the user's Details tab only shows the last 4 characters of the key.
If the key is lost, create a new Vrio API user to get a new key.
Authentication
The API endpoint is: api.vrio.app
If you are unfamiliar with HTTP headers, learn more here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers
Required Headers
All API requests require the following header:
curl "https://api.vrio.app/campaigns" \
-H 'X-Api-Key: YOUR_API_KEY'Important Notes
- The most common 403 error relates to missing header parameters
- The API key does not expire
- Make sure to keep this API key secret
Generate the Legacy API Key
The Legacy API (formerly Sublytics API) is still used by third party vendors who are integrated to either Vrio.app or Sublytics.com.
You will need to check with your provider to know which API they are integrated with. Learn more about the Legacy API.