This repository represents an example of how to implement the Toast Gift Card Integration API.
It's a basic server written in Node.js that handles requests from Toast.
db.json represents a database. This is where the gift cards and transactions are stored. You can also edit and view the data just like any other json file (if you make edits you must restart the server to access the edits).
Gift card, transaction, and database related functions can be found in cards.js, transactions.js, and db.js respectively. These files are less important however some of the required error responses are thrown in cards.js and transactions.js.
The majority of the logic can be found in server.js. This is where incoming requests are handled and dealt with accordingly. It is also where JWT verification is handled.
First, You have to have node and npm installed.
Clone the repository and cd into it.
Install all the node dependencies with:
npm install
Then start the server with:
npm start
Now the server will be running at localhost:18181
By default it will use the public key (for JWT verification) from the Toast sandbox environment. However you can change the URL of the public key by supplying it as an argument to npm install. So if I wanted to use the public key from the Toast production environment I would supply run the server like so:
npm start https://ws-api.toasttab.com/usermgmt/v1/oauth/token_key
to reset the database run:
npm run reset
Included in this repository are Postman test scripts which can be used to test an implementation of the Toast Gift Card API. Currently they are configured to test this reference implementation although they can be configured to test any implementation.
They can be run through the Postman GUI or the command line.
To run the tests on the command line, simply run npm test (with the server running).
You can configure these tests to hit your endpoint by editing the verify_GC.postman_collection.json file, in the "variable" section at the bottom. But this is much easier to do in the Postman GUI.
Download and install Postman here: https://www.getpostman.com/
Follow this guide to import, run, and configure the test scripts in Postman https://docs.google.com/document/d/1An94NrwCtqefX1Z2XXpi6hvIwhEELhL7Ijo5_GsWVxk/edit?usp=sharing