Skip to content

REST API, web server

156

This node allows the ERGS environment to function as a localized web server. It exposes a specific URL (endpoint) that external devices or applications can interact with using standard HTTP requests. This is the core component for building "connected" games where physical puzzles interact with mobile apps, custom web dashboards, or IoT hardware like ESP32 or Arduino.

When to use this node: * Custom Interfaces: Use it to build a web-based "hacking" terminal or a keypad on a tablet that players use to interact with the room. * Third-Party Hardware: When using Wi-Fi-enabled sensors or buttons that need to "tell" the game engine that a task has been completed. * Dynamic Responses: The response pin allows you to send data back to the caller, such as a confirmation code or a hint, based on the current game logic.

Technical Note: The endpoint is automatically generated at the path /api/node/[API name]. For instance, if the API name is set to start_sequence, the full URL will be http://[SERVER_IP]:8080/api/node/start_sequence.

Connectors in

  • response [type: string]
  • httpCode [type: integer]
  • contentType [type: string]

Connectors out

  • process [type: action]
  • request [type: string]
  • postData [type: string]
  • peerIP [type: string]

Node properties

  • API name [type: string]
  • contentType [type: string]
  • httpCode [type: integer]