Mavis Store

Overview

Mavis Store (store.skymavis.com) is an online marketplace where game developers can sell their in-game items to players, including both on-chain and off-chain items. It offers environments for testing (sandbox) and production to ensure smooth sales integration.

This documentation is intended for game studios setting up a store on Mavis Store. Throughout the documentation, we refer to you, the seller, as the "merchant."

Features

• Create on-chain and off-chain items in a user-friendly interface.
• Create and run private sales for specific customer groups.
• Create promotion codes for discounts.
• Accept payments through users' Ronin Waypoint keyless wallets.

Integration

What you need

Prepare the following before integrating with Mavis Store:

• Graphic assets for the store, including a store logo, item images, and banners. For details, see Register as a merchant.
• If your sale includes NFTs, prepare the NFT smart contract for deployment to Ronin. Deploy to the Saigon testnet first, complete a security review with Sky Mavis, and then deploy to the mainnet.
• Prepare your backend server to accept webhooks from the Mavis Store API when a purchase is made, as well as other endpoints. The specific endpoints depend on your integration level. For more information, see Integration levels.

Integration steps

1. Register as a merchant:
   1. Sign in to the Developer Console and create an app.
   2. Request access to the Mavis Store service in App Permissions > Mavis Store.
   3. Contact Sky Mavis for access to the sandbox environment.
2. Prepare graphic assets for the store.
3. Set up the store in the sandbox environment:
   1. Sign in to the sandbox Mavis Store CMS.
   2. Enter the store information and upload the graphic assets.
   3. Add some items through the sandbox CMS.
   4. Using the preview feature, verify that the items look as expected in the sandbox storefront.
4. Integrate your backend with the Mavis Store API:
   1. Learn about the integration levels to choose the right level for your project.
   2. Integrate either the basic or advanced API endpoints.
   3. For advanced integration, contact Sky Mavis to enable.
   4. Save the API endpoints in the sandbox Mavis Store CMS.
5. Test your integration by purchasing items in the sandbox storefront.
6. If successful, set up the store in the production environment:
   1. Sign in to the production Mavis Store CMS.
   2. Enter the store information and upload the graphic assets.
   3. Add all items through the production CMS.
   4. Submit your items for review and approval by Sky Mavis.
   5. In the production CMS, hide the production environment in the store settings so that your store is only visible in the pre-production environment.
   6. Publish your items to the pre-production storefront and verify that they look as expected.
   7. Enable the production environment in the store settings to make your store visible in the production environment.

CMS and storefront environments

Mavis Store has multiple environments for testing and production, supporting both the CMS for managing items and sales, and the storefront displaying items to players.

Environment	Type	Domain	Network
Sandbox	CMS	mavis-store-cms-sandbox.vercel.app	Saigon testnet
Sandbox	Storefront	mavis-store-cms-sandbox.vercel.app	Saigon testnet
Pre-production	Storefront	mavis-store-preproduction.vercel.app	Ronin mainnet
Production	CMS	store-cms.skymavis.com	Ronin mainnet
Production	Storefront	store.skymavis.com	Ronin mainnet

Integration flow

The integration flow involves moving through different environments, from sandbox to pre-production and production, to test and deploy your items and sales campaigns. The following flowchart outlines the process from creating an app to publishing items on the storefront:

Next steps

Register as a merchant