👁 Image
VenlyAPI.Companion.Beamable 3.1.0

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.