Skip to content

quickstart.mdx

Latest commit

 

History

History
112 lines (87 loc) · 3.73 KB

quickstart.mdx

File metadata and controls

112 lines (87 loc) · 3.73 KB
title Quickstart
description Bring RestaurantPOS, TicketPOS, and EasyAPI into your experience in a few steps.

Choose what you are setting up

Decide which Aware products you need:

  • RestaurantPOS – in-experience ordering and payments (inside Roblox via AG | RestaurantPOS).
  • TicketPOS – ticket sales and access control (inside Roblox via AG | TicketPOS).
  • EasyAPI – Roblox Lua helper for calling Aware HTTP APIs (including Dynaban and Atlas in the future).

You can add products one-by-one. RestaurantPOS and TicketPOS run fully in your Roblox game, while EasyAPI talks to Aware’s backend services.

Step 1: Create an Aware project (for EasyAPI and backend APIs)

1. Sign in to your Aware dashboard. 2. Create a new project for your experience (for example, **Main Restaurant Tycoon**). 3. Note your **Project ID** and **API key** – you will use these with EasyAPI and HTTP APIs (Dynaban, Atlas). We recommend at least two environments: 
- **Sandbox** – for local testing and private Roblox places.
- **Production** – for your live game.

For each environment, create a separate API key and restrict usage to the correct servers.

Step 2: Connect from Roblox (EasyAPI)

If you are integrating backend APIs (like Dynaban) from Roblox, use EasyAPI so you do not have to write raw HTTP requests.

1. Add the EasyAPI ModuleScript to `ReplicatedStorage` or `ServerScriptService`. 2. Configure your `ProjectId` and `ApiKey` inside the module or via a config script. 3. Make sure only server-side code can access your API key. 
local EasyAPI = require(game.ServerScriptService.EasyAPI)

local client = EasyAPI.new({
  projectId = "your-project-id",
  apiKey = "your-server-api-key",
  environment = "sandbox",
})

local result, err = client:call("dynaban.evaluate", {
  userId = player.UserId,
  placeId = game.PlaceId,
})

if err then
  warn("Dynaban request failed", err)
  return
end

if result.riskScore >= 70 then
  player:Kick("Your account has been banned by Aware.")
elseif result.riskScore >= 50 then
  player:Kick("Your account has been flagged by Aware.")
end

Step 3: Enable RestaurantPOS or TicketPOS

1. Follow [RestaurantPOS overview](/restaurantpos/overview) to understand components. 2. Complete [RestaurantPOS setup](/restaurantpos/setup) to import `AG | RestaurantPOS`, define locations, menus, and registers. 3. Integrate ordering flows as described in [RestaurantPOS operations](/restaurantpos/operations) using the `API` object. 1. Read [TicketPOS overview](/ticketpos/overview). 2. Configure events, ticket types, and price tiers in [TicketPOS setup](/ticketpos/setup) after importing `AG | TicketPOS`. 3. Implement check-in and entitlements as shown in [TicketPOS operations](/ticketpos/operations) using the `API` object.

Step 4: Wire in Dynaban and Atlas

Moderation and licensing are handled by Aware APIs.

Use risk scores to automatically kick at scores ≥ 50 and ban at scores ≥ 70. Plan license and entitlement checks for future Atlas integration.