Overview

Welcome to our API page! You can utilize our APIs to tackle task associated to each of the sections below:

pageGamespageCollectionspageTokenspageMarketplacepageTransactionspageUsers

Qualified Names

Definitions

OpenVessel uses reverse domain notation to identify games, collections, and tokens. This naming convention is an additive scheme: the fully qualified name of the child is prefixed with its parent’s name.

Qualified Name vs. Fully Qualified Name

The qualified name is the name of the object itself. The fully qualified name is the object’s parent’s fully qualified name prefixed to the object’s name.

For example, if a studio called “Fun Games” creates a collection called “Cards” for its Solitaire game, the collection’s qualified name is cards, while its fully qualified name is com.fungames.solitaire.cards.

Nomenclature

OpenVessel API uses the following nomenclature:

Short NameFull NameExample

FQSN

Fully Qualified Studio Name

com.fungames

QGN

Qualified Game Name

solitaire

FQGN

Fully Qualified Game Name

com.fungames.solitaire

QCN

Qualified Collection Name

cards

FQCN

Fully Qualified Collection Name

com.fungame.solitaire.cards

QTN

Qualified Token Name

joker

FQTN

Fully Qualified Token Name

com.fungames.solitaire.cards.joker

Last updated