Skip to content
This repository was archived by the owner on May 7, 2024. It is now read-only.

api.md

Latest commit

 

History

History
199 lines (158 loc) · 4.59 KB

api.md

File metadata and controls

199 lines (158 loc) · 4.59 KB
Raw

API Documentation

Version: 1
Prefix: /v1

Routes:

POST /users

Registers a new user in the Detactive ecosystem.

Response Example:

{
  "uuid": "87c44130-af78-4c38-9d58-63d5266bde4a"
}

GET /users/{user_uuid}/token

Gets a corresponding token for given user. The token is valid for 30 minutes.

Response Example:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxOWI5NWE1ZC1iZTRhLTQ4YmEtOGRkOC1hOTAwZTY1M2Q4MDMiLCJleHAiOjE2OTM3NDk5MDksImlhdCI6MTY5Mzc0ODEwOX0.9NG_1cjAJpNqzk9AV-HXrMmLYWN-k_D9GYfqDb4aHTc"
}

GET /stories?lat={}&lon={}

Gets list of potential "games" that are playable around given coordinates.

Response Example:

[
  {
    "uuid": "4799b75f-50c8-4086-9b65-a12352165ca7",
    "title": "Der Banküberfall",
    "image": "https://avatars.githubusercontent.com/u/124081268",
    "description": "Finde den Täter ...",
    "distance": 2, // in meters
    "duration": 20 // in minutes
  }
]

GET /stories/{story_uuid}

Gets information about story and game progress for given story uuid in the url. [game progress tracker planned]

Response Example:

{
  "story": {
    "uuid": "4799b75f-50c8-4086-9b65-a12352165ca7",
    "title": "Der Banküberfall",
    "image": "https://avatars.githubusercontent.com/u/124081268",
    "description": "Finde den Täter ...",
    "distance": 2, // in meters
    "duration": 20 // in minutes
  },
  "userActivities": [
    {
      "startedAt": "2023-09-03T15:04:54.366847",
      "finishedAt": null
    },
    {
      "startedAt": "2023-09-01T15:04:54.366847",
      "finishedAt": "2023-09-02T15:04:54.366847"
    }
  ]
}

POST /games/{story_uuid}/start

Registers a new game to play for the user at given story_uuid in the url and using the users current position for the body payload.

Body Example:

{
  "lat": 52.51678368791737,
  "lon": 13.385774895470805
}

Response Example:

{
  "uuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f2",
  "description": "story.museumheist.step.gotomuseum.description",
  "mediaType": null,
  "src": null,
  "title": "story.museumheist.step.gotomuseum.title",
  "decisions": [
    {
      "uuid": "27d8e03d-c025-4e7d-9c31-eb38d5e2adc2",
      "stepInputUuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f2",
      "stepOutputUuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f3",
      "title": "story.museumheist.step.gotomuseum.decision.acceptentercrimescene.title"
    }
  ],
  "waypoint": {
    "uuid": "4fa1b998-bc77-4c8a-bc50-af8288581ffa",
    "coordinates": {
      "lat": 52.511293722902735,
      "lon": 13.393637537956238
    }
  }
}

POST /games/{story_uuid}/steps/{step_uuid}

Gets next step for the user in the current & active game. Optionally you can use the "to" entry to decide what next step to use, if there are multiple available.

Body Example:

{
  "lat": 52.51678368791737,
  "lon": 13.385774895470805
}

Response Example:

{
  "uuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f3",
  "description": "story.museumheist.step.examinecrimescene.description",
  "mediaType": "VIDEO",
  "src": "https://videos.ctfassets.net/tiy4aehfiie3/3WHnU7SCQdr4jRZ781LVAk/0cdd5ea48045b3bc665b3f1488d06429/missing-painting_museum-heist.mp4",
  "title": "story.museumheist.step.examinecrimescene.description",
  "decisions": [
    {
      "uuid": "27d8e03d-c025-4e7d-9c31-eb38d5e2adc3",
      "stepInputUuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f3",
      "stepOutputUuid": "7a1d8a9a-2d51-4abe-baa9-b2ee5c13e3f4",
      "title": "story.museumheist.step.examinecrimescene.decision.acceptleavecrimescene.title"
    }
  ],
  "waypoint": null
}

GET /games/{story_uuid}/steps/history

Gets a history of all played steps + the current objective in present mission.

Response Example:

[
  {
    "title": "story.museumheist.step.thrillingnews.title",
    "description": "story.museumheist.step.thrillingnews.description",
    "finished_at": "2023-09-06T18:47:21.825942"
  },
  {
    "title": "story.museumheist.step.examinecrimescene.title",
    "description": "story.museumheist.step.examinecrimescene.description",
    "finished_at": "2023-09-06T18:47:24.925614"
  },
  {
    "title": "story.museumheist.step.suspiciouscarnews.title",
    "description": "story.museumheist.step.suspiciouscarnews.description",
    "finished_at": "2023-09-06T18:47:29.230178"
  },
  {
    "title": "story.museumheist.step.collectevidence.title",
    "description": "story.museumheist.step.collectevidence.description",
    "finished_at": null
  }
]

DELETE /games/{story_uuid}/delete

Closes the active game. Returns an 202 when successful.