API documentation

Back to home page

Content table:

/api/generate

This endpoint requires post method, accepts json paylod with data.

General json template:

{
    "gameId": String,
    "challenge": {
        "id": String,
        "nonce": Int,
        "hash": String
    },
    "earnedPoints": {
        "BP": { "amount": Int }
    },
    "assetClicks": {
        "CLOVER": { "clicks": Int },
        "FREEZE": { "clicks": Int },
        "BOMB": { "clicks": Int }
    }
};

Drop game claim json:

{
  "gameId": String,
  "earnedPoints": {
      "BP": { "amount": Int }
  },
  "assetClicks": {
      "CLOVER": { "clicks": Int },
      "FREEZE": { "clicks": Int },
      "BOMB": { "clicks": Int }
  }
};

Example for drop game:

{
  "gameId": "ec4e3774-b5a7-4789-a23b-cc02cb655ca6",
  "earnedPoints": {
      "BP": { "amount": 219 }
  },
  "assetClicks": {
      "CLOVER": { "clicks": 74 },
      "FREEZE": { "clicks": 3 },
      "BOMB": { "clicks": 0 }
  }
};

/api/help

Returns current page

/api/status

Returns just the string "OK" if server can listen on this route. This does not guarantee that payload generation is available and the rest of the server routes are responding properly.

/api/testdata

Return the data used for test:

{
  "testData": { ... }
}

/api/test

Used to test functionality of generation. Uses internal example data and return json:

{ message: String }

Returns "OK" if test succeed