Welcome to schoox-api-wrapper 👋

Node.JS wrapper for the Schoox API

Notes

This is 80 % complete. There are just a handful of calls that are missing that I plan on adding in as soon as I can. If you would like to contribute don't hesitate to make a pull request or send me a message on Twitter.

• Badges - Completed
• Content - Completed
• Courses - Completed
• Curriculums - Completed
• Dashboard - Completed
• Events
• Exams - Completed
• Groups - Completed
• Usage - Completed
• Users

Prerequisites

• node >= 8

Install

npm install schoox-api-wrapper

Usage

Include the package

 const schooxAPI = require('schoox-api-wrapper')

Then intiate the module using your academy ID and API key

const api = schooxAPI('226581108', '9d3419535b0c8d76f7f6f72800f62f92')

Then you can start running your calls. Using the getUsage call as an example.

api.usage.getUsage((err, data) => {
    if(err)
        return console.error(err);

    return console.log(data);

});

This would give you the response

{ availableCalls: 2000, until: '2000-01-01T01:01:01+00:00' }

Author

👤 Brandon L

• Github: @Spazz

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2023 Brandon L.
This project is MIT licensed.

---