🌐Flex API
Bounce Flex RESTful Web API documentation
Overview
The Flex API provides methods for interacting with Bounce Flex-enabled cross-world experiences, allowing you to easily share secure access to dynamic assets, content and experiences in a range of connected spaces and platforms.
The Flex API supports programmatically claiming digital assets to user accounts, generating platform-specific activation links, and interacting with our Web Portal and in-game SDK to power seamless fan experiences from your site or app and into any supported environment.
The Flex API is also tightly integrates with Link phygital collectibles, allowing you to manage Flex digital assets and experiences without worrying about user authentication, and based on Link Tag tap codes.
For details on API authentication, limits and environments see API Overview
Flex terminology explained
Bounce Flex is a cross-world digital content and experience platforms that powers the expansion of products, assets and IP across the metaverse. Flex works by linking "core assets", whether Link phygitals, connected NFTs or other types of digital collectibles, to platform-specific assets that can be attached to digital collectibles.
There are three types of assets that describe a Flex integration with a platform for a specific project:
Connection
A connection represents the link between Flex and a platform for a given project, and its related IP, digital media assets, and in-platform assets.
By enabling a connection you make a certain platform asset class (such as a Sandbox avatar, Snap lens, of in-game asset) available for claim and use.
In programming terms, you can think of a connection as a class.
Asset
An asset represents an instance of the connection for a particular digital collectible (and particular owners).
An asset can have specific traits, be owned by a user, or attached ("bound") to a digital collectible across trades (depending on the platform).
Assets can be automatically claimed when a digital collectible is claimed, claimed in a secondary step, or even sold separately.
In programming terms, you can think of an asset as an instance of a class.
Activation
An activation is a short-lived token, URL, deep-link or claim code that facilitates the activation of a Flex asset inside a metaverse platform, app or game.
Activation links are short-lived to ensure security of exclusive assets & experiences.
Here is a typical flow of how a Flex asset is claimed and activated:
Example Flex API usage
Flex API interaction flow to unlock exclusive access to an avatar on a metaverse platform for an owner of a Link Tag-enabled collectible or any compatible digital asset.
Flex API endpoints
GET Flex connections available for project
GET Flex connections available for projectAvailable Flex connections for project
GET https://api.letsbounce.gg/v1/flex/{project_id}/connections
This endpoint returns a list of available Flex platform connections for a given project.
Connections are available when they have been enabled and correctly configured.
Note: currently connections cannot be enabled or disabled via the API
Path Parameters
project_id*
String
Flex project ID
Available Flex connections response:
{
connections: [
{
id: string, // Flex connection platform ID
label: string, // Connection platform label
media: {
icon: string // connection platform icon
preview_img?: string // connection platform preview image URL
preview_vid?: string // connection platform preview video URL
},
persistant: boolean, // Is a connection linked to a digital asset
transferable: boolean, // Is a connection asset transferable
issue: {
costCode: string // Cost indicator for assets
limited: number // Limited quantity? (0 if not)
remaining: number // If limited, how many assets remaining
},
traits?: [ // List of connection asset variable traits (optional)
{
id: string, // unique trait ID (auto-generated)
label: string, // trait name
media: {
icon: string // trait icon
preview_img?: string // trait preview image URL
preview_vid?: string // trait preview video URL
},
values: [{
id: string, // unique trait value ID (auto-generated),
label: string, // trait value label
chance: number, // value rarity proportion
media: [
icon: string // value icon
preview_img?: string // value preview image URL
preview_vid?: string // value preview video URL
],
data: object, // arbitrary value data
}],
...
}
]
},
...
]
}GET Flex connection status
GET Flex connection statusStatus of Flex connection for project
GET https://api.letsbounce.gg/v1/flex/{project_id}/connections/{connection_id}
This endpoint returns the status of a connection for a given project.
Path Parameters
project_id*
String
Flex project ID
connection_id
String
Flex platform connection ID
(platform enum)
Flex connection status response:
{
id: string, // Flex connection platform ID
enabled: boolean // Is connection enabled?
label: string, // Connection platform label
media: {
icon: string // connection platform icon
preview_img?: string // connection platform preview image URL
preview_vid?: string // connection platform preview video URL
},
persistant: boolean, // Is a connection linked to a digital asset
transferable: boolean, // Is a connection asset transferable
issue: {
costCode: string // Cost indicator for assets
limited: number // Limited quantity? (0 if not)
remaining: number // If limited, how many assets remaining
},
assets: {
issued: number, // how many assets have been issued for connection
},
traits?: [ // List of connection asset variable traits (optional)
{
id: string, // unique trait ID (auto-generated)
label: string, // trait name
media: {
icon: string // trait icon
preview_img?: string // trait preview image URL
preview_vid?: string // trait preview video URL
},
values: [{
id: string, // unique trait value ID (auto-generated),
label: string, // trait value label
chance: number, // value rarity proportion
media: [
icon: string // value icon
preview_img?: string // value preview image URL
preview_vid?: string // value preview video URL
],
data: object, // arbitrary value data
}],
...
}
]
}GET Flex asset status
GET Flex asset statusStatus of Flex asset
GET https://api.letsbounce.gg/v1/flex/{project_id}/assets/{asset_id}
This endpoint returns the status of a Flex asset
Path Parameters
project_id*
String
Flex project ID
asset_id*
String
Flex asset ID
Flex asset status response:
GET Flex assets status by connection
GET Flex assets status by connectionStatus of assets for connection
GET https://api.letsbounce.gg/v1/flex/{project_id}/connections/{connection_id}/assets
This endpoint returns the status of a batch of Flex assets by connection
Path Parameters
project_id*
String
Flex project ID
asset_id*
String
Flex connection ID
Query Parameters
offset
String
query offset
count
String
batch query size
Flex assets status by connection response:
POST Issue a Flex asset
POST Issue a Flex assetClaim a Flex asset for a given connection
POST https://api.letsbounce.gg/v1/flex/{project_id}/assets/{asset_id}/issue
This endpoint can be used to issue a new asset instance for a connection. If traits are configured for the asset, they can be set in the body of the request, or randomized as set.
Assets can be issued to Bounce users by user token or by user delegation, allowing you to link asset ownership to your own user accounts.
Flex asset issue response:
GET Flex activation status
GET Flex activation statusStatus of Flex activation
GET https://api.letsbounce.gg/v1/flex/{project_id}/activations/{activation_id}
This endpoint returns the status of a Flex activation, a short-lived link or token used to securely share Flex-enabled experiences in connected platforms.
Activations may have the status of: invalid, active, expired, opened and claimed.
Path Parameters
project_id*
String
Flex project ID
activation_id*
String
Flex asset activation ID
Flex asset activation status response:
POST Generate Flex activation
POST Generate Flex activationGenerate an activation for a given Flex asset
POST https://api.letsbounce.gg/v1/flex/{project_id}/activations/issue
This endpoint can be used to generate a short-lived activation link or token that can be used to securely share a Flex experience with a user. Activation links & tokens are accepted by platforms and platform SDKs to guarantee an authorized unlocking of assets and experiences in platform.
Last updated
Was this helpful?