Skip to content

keboola/component-toast

Repository files navigation

Toast

This component extract data from the Toast API.

Supported endpoints

following endpoints are supported:

  • restaurant configuration
  • orders

Configuration

Authorization

Provide the URL, Client ID, and Client Secret to connect to your account.

Restaurants

You can choose to load all restaurants in management group or just a specific one.

Endpoints

You can select which endpoints you want to download.

Sync Options

Specify the date range for the orders you want to download.

Destination

Load Type: You can choose whether the output tables in the bucket should be incrementally loaded or if the entire table should be replaced.

Output

List of tables, foreign keys, schema.

Development

If required, change local data folder (the CUSTOM_FOLDER placeholder) path to your custom path in the docker-compose.yml file:

    volumes:
      - ./:/code
      - ./CUSTOM_FOLDER:/data

Clone this repository, init the workspace and run the component with following command:

git clone https://github.com/keboola/component-toast component-toast
cd component-toast
docker-compose build
docker-compose run --rm dev

Run the test suite and lint check using this command:

docker-compose run --rm test

Integration

For information about deployment and integration with KBC, please refer to the deployment section of developers documentation