GithubHelp home page GithubHelp logo

modernews / r6dle_api Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 29 KB

Simplistic Rest API for Wordle based R6 knowledge game (webpage down)

Home Page: https://r6dle.tech

Dockerfile 7.25% Python 92.75%

r6dle_api's Introduction

R6dle REST API

Introduction

This is basic REST API used to gather simple statistical data for the R6dle. There is no authentication or authorization implemented, and the Bearer token is purely for user identification, it does not provide any safety!!!

Routes

GET /token

Generates url safe token for user identification.

GET /stats/global

Returns global statistics for the daily operator in R6dle.
Query Parameters:

  • date - date in format YYYY-MM-DD (default: today)

GET /stats/user

Returns user statistics for the in R6dle - max_streak, current_streak, total_solves.

PATCH /stats

Requires token
Updates statistics with new guess, as provided (both user and global).
Query Parameters:

  • solves - number of guesses that it took user to solve the daily operator

GET /operator

Requires token
Returns the daily operator (as sha256 hash, to make it harder to scrape it for the user) for the R6dle.

CORS

Currently, CORS is enabled strictly for the https://rwlodarczyk.github.io - domain of R6dle, so it's harder to abuse the tokens.

Important Files and Directories to keep track of

  • postgres-data directory will store state of the postgres database from the Docker container.
  • static directory will store static files handled by the server

r6dle_api's People

Contributors

modernews avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.