Skip to main content

Prerequisites

  • An Aware project created in your dashboard.
  • An API key for your sandbox environment.
  • A Roblox experience where you can add server scripts.

Step 1: Add the EasyAPI module

Add the EasyAPI ModuleScript to one of:
  • ServerScriptService
  • ReplicatedStorage (and require it from server scripts)
Name it something clear such as EasyAPI.

Step 2: Configure the client

The EasyAPI module should expose a simple constructor.
The pattern used throughout these docs looks like this:
Your implementation can choose whether projectId, apiKey, and environment are passed in like this or loaded from a central config module.

Step 3: Implement the HTTP call helper

Inside your EasyAPI ModuleScript, you will implement a generic :call helper that all operations go through. Example implementation outline:
Update the baseUrl and header names to match your real backend.

Step 4: Test with Dynaban

Once the module is wired, make a test call to Dynaban as shown in the Quickstart or EasyAPI examples.