×
Toggle API console

Server responses

API reference

Roar Engine: Web API reference

Roar is a configurable game mechanics platform.

Web API

Each game has its own distinct API URL, usually something like http://{your.gamehost.com}/{yourgame}/.

All Roar API calls are formatted using the same pattern: /controller/action/ (ensuring a trailing slash). If your game key was 'rockstar', you'd access the /info/ping API call as follows:

Example: http://{your.gamehost.com}/rockstar/info/ping/

All calls to Roar Engine are done using HTTP POST. This is not strictly RESTful, but it is very cross-device and cross-platform friendly. Most calls require the sending of an auth_token (authentication token) as a parameter, which can be obtained by logging a user in using user/login or facebook/login_oauth. Content type (mandatory) and character set (optional) should be set in the http header as follows:

  • Content-type: application/x-www-form-urlencoded
  • Charset: UTF-8

    Server Responses

    All Roar API responses are structured using the same pattern for any given /controller/action/ API call:

    <roar tick="{servertime}">
      <controller>
        <action status="ok|error">
          <!-- Action responses returned here -->
        </action>
      </controller>
      <!-- Server updates here -->
      <server>
        <level_up value="5"/>
      </server>
    </roar>
    

    You may notice that along with the response to the API call that you have made, on occasion Roar will supply an additional <server> chunk of data. This data represents updates that have occurred within Roar that are relevant to the user (and often tied to recent API calls).

    See Server responses in this document for reference.



  • API Reference