Skip to content

API Documentation

sonsoleslp edited this page Aug 19, 2020 · 2 revisions

Although you can use the team interface provided by the Escapp platform for students to introduce the solution to the different escape room puzzles, you might want to develop your own puzzles using other resources: web applications, mobile apps, VR scenarios, Arduino... Basically, anything that can make an HTTP request can be used to develop a puzzle compatible with Escapp.

For this purpose, Escapp provides two APIs:

  • REST API: This API enables authenticated players to solve puzzles from external software applications.
  • Websockets API: This API allows to connect web applications (compatible with the ws/wss protocol) to Escapp in real-time, allowing participants not only to solve puzzles from outside Escapp but also to synchronize their progress with their team mates and to receive notifications in real-time (messages from the teacher, changes in the leaderboard, new puzzles solved by their team members, new hints obtained by their team members, etc.)