Welcome to RSBBQ’s Operations API’s documentation!

Operations API is a RESTful API for analyzing real-time restaurant sales and inventory data.It pulls data from Toast POS API and stores it in a MySQL database hosted on Google Cloud Platform. Data is then used to generate reports and insights for the business and their GM’s.

Warning

To get started, please request access to the github repository to view the code. There are links to source code throughout the documentation, and without permission, the code will not be visible.

Note

This documentation is a work in progress. It is intended to guide users through the custom API endpoints for RSBBQ.

Contents

• Home
• Project Overview
  • Project Overview
  • Directory Structure
  • Architecture
  • Key Technologies
  • Features
• Getting Started
  • Prerequisites
• Github
  • Terraform & Ansible
  • Stock Checker
  • Report
  • Annual Sales
  • Documentation
• Toast API Examples
  • Authentication
  • Get Menu Items
  • Check Store Stock