VenlyAPI.Companion.Beamable 3.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package VenlyAPI.Companion.Beamable --version 3.1.0
                    


                    

                
NuGet\Install-Package VenlyAPI.Companion.Beamable -Version 3.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="VenlyAPI.Companion.Beamable" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="VenlyAPI.Companion.Beamable" Version="3.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="VenlyAPI.Companion.Beamable" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add VenlyAPI.Companion.Beamable --version 3.1.0
                    


                    

                
#r "nuget: VenlyAPI.Companion.Beamable, 3.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package VenlyAPI.Companion.Beamable@3.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=VenlyAPI.Companion.Beamable&version=3.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=VenlyAPI.Companion.Beamable&version=3.1.0
                    


                            Install as a Cake Tool

Venly Companion for Beamable Backend

The Venly Companion for Beamable provides server-side helpers and extension routes to create and manage Venly users and wallets from a Beamable Microservice. It persists the minimal identifiers and PIN (for PIN signing) as private client stats so subsequent calls can authorize automatically.

Install

  • NuGet (microservice/server project):
    • Package Manager: Install-Package <PackageId>
    • .NET CLI: dotnet add package <PackageId>

Replace <PackageId> with the published NuGet ID for this package.

Configure (Realm Config)

In the Beamable Portal, add the following Realm Config entries under namespace venly:

  • client_id: Venly Client Id
  • client_secret: Venly Client Secret
  • environment: sandbox or production

The microservice initializes the Venly API using these values on startup.

Available Routes

Handled inside the microservice and forwarded to Venly:

  • has_user: Returns whether a Venly user id is linked
  • create_user: Creates a Venly sub-user and stores its id (and PIN if PIN signing is used)
  • get_user: Retrieves the linked Venly user
  • user_has_wallet: Returns whether a wallet id is linked
  • create_wallet: Creates a wallet for the linked Venly user; requires that a user exists. If PIN signing was used at user creation, the stored PIN is used to build VyUserAuth automatically
  • get_wallet: Retrieves the linked wallet

All routes return a VyServerResponseDto payload.

Integration Notes

  • These packages are used alongside Venly's Unity/Unreal Gaming SDKs to automatically provide Beamable Microservice backend support out of the box.
  • They act as helper relays to forward calls originating from your Unity/Unreal clients; no additional client-side examples are required here.

Notes

  • Never expose the PIN to clients; it is stored as a private stat by the microservice and only used server-side to create VyUserAuth.
  • Environments are sandbox or production. Older versions used staging to refer to the Sandbox environment.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
3.1.0 161 10/20/2025
3.0.0 299 9/16/2025
1.0.10 209 3/13/2024
1.0.9 243 1/3/2024