Skip to content

Getting Started with Patcher API

Prerequisites

Before you can use the Patcher API, you need:

  1. Developer Profile: A registered developer account with Nova Suite
  2. Registered Application: Your app must be registered in the system
  3. API Key: An API key (nuve_...) with access to your app

Step 1: Register Your Application

Visit the Nova DevCon dashboard (https://devcon.novasuite.one) to register your application. You'll need to provide:

  • Developer Name: Your organization/developer identifier (e.g., nova-suite)
  • App ID: A unique identifier for your app (e.g., one.novasuite.myapp)
  • App Name: Human-readable name
  • Platform: Windows, macOS, Linux, or Universal

Step 2: Get Your API Key

Your API key will be provided after registration. It looks like this: 

nuve_abc123def456...

⚠️ Keep this secret! Store it in: - GitHub Secrets (for CI/CD) - Environment variables (for local testing) - Password managers (for manual use)

Step 3: Test Your Setup

Use the provided test script to verify everything works:

Windows (PowerShell)

.\test-patcher.ps1 -ApiKey "nuve_YOUR_KEY" -DevName "your-dev-name" -AppName "your-app-id"

What the test does:

  1. Requests a signed upload URL
  2. Uploads a dummy file to S3
  3. Registers release metadata in the database
  4. Verifies the manifest endpoint returns your release

Step 4: Understand the Workflow

The typical release process:

1. Build your application
   ↓
2. Package as .zip (or .exe, etc.)
   ↓
3. Request Upload URL from /cdn-upload
   ↓
4. Upload file to S3 using the signed URL
   ↓
5. Register metadata via /upload
   ↓
6. Users check for updates via /check

Next Steps