Umbraco Connector
Installation

Installation

Install the NuGet package

The connector is a standard NuGet package. Add it to your Umbraco web project:

Terminal
dotnet add package Uxbee.Umbraco.Bynder

Or add the reference to your .csproj yourself:

.csproj
<PackageReference Include="Uxbee.Umbraco.Bynder" Version="17.*" />

Build and start the site. You don't need to copy any files or register anything in code:

  • The backoffice UI is included in the package and loads automatically.
  • The Bynder section in appsettings.json gets IntelliSense and validation in Visual Studio and VS Code.
  • A "Find all Bynder log entries" saved search is added to the Log Viewer.

Add your license key

Nothing works until a valid license key is set. Until then, the pickers stay closed and the portal domain can't be configured. Your license key is the API key from the Bynder integration portal.

You can set the key in three ways. If more than one is set, the first one in this list wins.

a. appsettings.json (recommended)

appsettings.json
{
  "Bynder": {
    "LicenseAPIKey": "your-license-api-key"
  }
}

The key name isn't case-sensitive. You can also set it with the standard environment variable Bynder__LicenseApiKey.

b. A single environment variable

BYNDER_LICENSE_API_KEY=your-license-api-key

The connector only reads this variable if option a isn't set.

c. The backoffice

Go to Settings > Bynder > Configuration > License. This box is only available to administrators, and only editable when neither option a nor b is set.

The key is checked straight away (for config-based keys, shortly after startup) and again at regular intervals. If a key is revoked or expires, the connector switches its backoffice functionality off without a redeploy. Content already published on your website keeps working.

Updating

Update the package like any other NuGet package, staying on the 17.x versions for Umbraco 17. Within one Umbraco major, every update is backwards compatible, and any database changes the connector needs run automatically on startup.

Next step

Configure the connector: connect your Bynder portal and create your first Data Type.