Skip to content

raphckrman/turboself-api

Repository files navigation

turboself-api

npm npm version npm npm

A simple wrapper to interact with the TurboSelf API.

Warning

This project is not affiliated with TurboSelf or INCB in any way.

📝 Roadmap

  • Authentification

    • With credentials
    • With token (with Pronote for example)
  • Reset password request (with email)

  • Get informations

    • Balance
    • Bookings
    • History
    • Host
    • Last transaction
    • Permissions to book evenings meals
    • Siblings
    • User
  • Seaching an etablishment

    • By city
    • With Limit
  • Get etablishment informations

  • Book a meal (book and cancel)

📦 Installation

npm install turboself-api

🔧 Usage

Authentification with credentials

const TurboSelf = require("turboself-api");

async function main() {
  let client = await TurboSelf.authenticateWithCredentials({
    username: "your_email",
    password: "your_password",
  });
  console.log(client);
}

main();

Other exemples

To see more examples, check the examples folder.

௷ Credits

Thanks to the following people for their contributions to this project: