Skip to content
RallyHere Docs

Integration Layers

RallyHere includes a rich set of plugins for various game engines to make integration and development as easy as possible.

Purpose-built for your engine of choice

There are many advantages of this approach, but the chief advantage is maintainability. We want developers to feel comfortable investigating the code we provide. To ensure it accomplishes their goals and increase comfort with the code style - which makes the code easier to debug and modify when developers need it to behave differently.

Use what you need, and nothing more

All the RallyHere integration layers are a stopping point, if you want. We provide these layers to allow developers to decide what kind of integration is the best fit for their project.

Layer 1: Web Endpoints

The Environment API is the lowest level of integration, and is the most flexible. It is a RESTful API, and can be used from any language or platform that supports HTTP requests. It is defined using an OpenAPI specification file, which is available here.

Layer 2: Generated API Clients

The OpenAPI specification file is used to generate a language/engine specific implementation of the bare API calls.

If you are integrating with RallyHere using an engine or technology that we don’t have primary support for, this will likely be the furthest layer we can offer assistance at.

Layer 3: Integration and Debug Tool

RallyHere provides a plugin (or series of plugins) for each of our primary supported game engines that aids in integration. These plugins are written to solve several complexities:

  • Best Practices - Our plugins are written to follow best practices for the API calls and the engine.
    • Caching - Many of our APIs include responses that are cachable to avoid unnecessary calls or data transfer.
    • Refreshing - Many of our APIs expect the client to poll for changes.
  • Platform Integration - Engines often include common practices for authentication, purchasing and other social features for each platform. Our plugins are written to manage many of the connection points between the engine and the RallyHere APIs.

Debug Tools

Every engine integration also includes a debug tool. This tool was developed alongside the integration layer and allows developers to quickly debug the integration with a UI overlay. This overlay is built to work on all platforms, and allow inspection of the many components of the integration as well as tracking of individual web requests flowing through the system.

Layer 4: RallyStart

Some of our supported engines also include sample games that can be used as reference for how to use the integration layer in your game, or as a starting point for your game. These games are designed to be as simple as possible, but include a number of features that are common to many games.