Quick Start

Create your first tokenized object in under 5 minutes.

Prerequisites

Before you begin, make sure you have:

  • A registered wallet account (POST /wallets/register)
  • An organization created (POST /organizations)
  • An API key (POST /api-keys)

Step 1: Create a Template

Templates define the structure of your objects. Create one with POST /templates:

{
  "name": "io.example.product",
  "description": "A product token template",
  "private": {
    "serial_number": "",
    "manufacture_date": ""
  }
}

Step 2: Create a Template Variation

Variations define specific configurations of a template. Use POST /templates/{templateId}/variations.

Step 3: Register a Face

Faces define how your objects are visually represented. Register one with POST /faces:

{
  "template": "io.example.product",
  "display_type": "image",
  "url": "https://example.com/product-image.png"
}

Step 4: Register Actions

Actions define what operations can be performed on objects. Create action types with POST /ebus/action-types.

Step 5: Emit an Object

Finally, create (emit) an object instance by executing an emit action through the Event Bus: POST /ebus/actions.