Setting Up Your App

This guide will walk you through creating and configuring your first application in the Oviato Developer Dashboard.

Prerequisites

Before you begin, you'll need:

• An Oviato account (sign up at dashboard.oviato.com)
• Your application's domain(s) where you'll integrate Oviato

Step 1: Access the Dashboard

1. Go to dashboard.oviato.com
2. Sign in with your Oviato account
3. You'll land on the dashboard home page

Step 2: Create a New Application

1. Click "Create New App" or "New Application" button

2. Fill in the required information:

   • App Name: A friendly name for your application (e.g., "My DeFi App"). This is an internal name and won't be visible to your users.
   • Select Network: Currently we support Bitcoin. More networks being added.

Step 3: Configure App Settings

After creating your app, you'll need to configure the following settings:

Basic Information

• App Name: Update anytime if needed
• App ID: Auto Generated ID for your App. You will be using this ID in the SDK

  // You'll use this App ID in your code
  <OviConnectProvider appId="your-app-id-here" />

Allowed Domains

Add the domains where your app will be hosted:

1. Click "Add Domain"
2. Enter your domain (e.g., https://myapp.com or http://localhost:3000 for development)
3. Click "Add"

Important:

• Include both production and development domains
• Localhost addresses are supported for testing
• Wildcards are not supported for security reasons

Branding (Optional)

Customize how Oviato authentication appears to your users:

• Logo: Upload your app logo (recommended: 200x200px PNG or SVG)
• Brand Color: Choose your primary brand color
• Theme: Select light or dark theme

These settings affect the authentication modal and wallet UI shown to your users.

Step 4: Copy Your App ID

1. In your app settings, locate the App ID field
2. Click the copy icon or select and copy the ID
3. Save this somewhere secure - you'll need it for SDK integration

Step 5: Environment Selection

Oviato supports multiple environments:

• Production: For live applications
• Staging: For testing before deployment

You can switch between environments in the dashboard sidebar.

Step 6: SDK Integration

Now that your app is configured, integrate the Oviato SDK:

For React/Next.js:

npm install @oviato/connect

import { OviConnectProvider } from "@oviato/connect/client";

<OviConnectProvider appId="your-app-id" network="bitcoinmainnet">
  {children}
</OviConnectProvider>;

→ Full @oviato/connect Documentation

For Other Frameworks:

npm install @oviato/sdk

import { initialize } from "@oviato/sdk";

await initialize({
  appId: "your-app-id",
  network: "bitcoinmainnet",
});

→ Full @oviato/sdk Documentation

Managing Your App

View App Analytics

The dashboard provides insights into:

• Total users
• Authentication events
• Transaction volume
• Network usage

Update App Settings

You can update your app settings anytime:

1. Select your app from the sidebar
2. Navigate to the settings you want to change
3. Make your updates
4. Changes take effect immediately

Multiple Apps

You can create and manage multiple applications:

• Each app has its own App ID
• Apps can have different configurations
• Switch between apps using the sidebar dropdown

Security Best Practices

• Never expose your App ID in public repositories (if it includes sensitive configuration)
• Use environment variables to store your App ID

  # .env.local
  NEXT_PUBLIC_OVIATO_APP_ID=your-app-id

• Regularly review allowed domains to ensure only authorized domains can use your app
• Monitor your app's usage in the analytics dashboard

Troubleshooting

"Domain not allowed" error

• Verify the domain is added to your allowed domains list
• Check for typos in the domain URL
• Ensure you're using the correct protocol (http/https)

App ID not working

• Confirm you copied the entire App ID
• Check that you're using the correct environment (staging vs production)
• Verify the SDK is properly initialized

Next Steps

• Integrate @oviato/connect - Install and setup the React SDK
• Integrate @oviato/sdk - Install the framework-agnostic SDK