Introduction

Welcome!

In this tutorial, we will build a REST API to expose interactions with stores, items, tags, and users. The API will allow clients to do various operations, including:

• Create and retrieve information about stores.
• Create, retrieve, search for, update, and delete items in those stores.
• Create tags and link them to items.
• Search for items with specific tags.
• Add user authentication to the client apps using the API.

Kurro Stores REST API Endpoints

Here are the endpoints we will build and expose in this tutorial.

Users

Method	Endpoint	Description
POST	/register	Create user accounts given an email and password.
POST	/login	Get a JWT given an email and password.
🔒 POST	/logout	Revoke a JWT.
🔒POST	/refresh	Get a fresh JWT given a refresh JWT.
GET	/user/{user_id}	(dev-only) Get info about a user given their ID.
DELETE	/user/{user_id}	(dev-only) Delete a user given their ID.

Stores

Method	Endpoint	Description
GET	/store	Get a list of all stores.
POST	/store	Create a store.
GET	/store/{id}	Get a single store, given its unique id.
DELETE	/store/{id}	Delete a store, given its unique id.

Items

Method	Endpoint	Description
🔒GET	/item	Get a list of all items in all stores.
🔒🔒POST	/item	Create a new item, given its name and price in the body of the request.
🔒GET	/item/{id}	Get information about a specific item, given its unique id.
PUT	/item/{id}	Update an item given its unique id. The item name or price can be given in the body of the request.
🔒DELETE	/item/{id}	Delete an item given its unique id.

Tags

Method	Endpoint	Description
GET	/store/{id}/tag	Get a list of tags in a store.
POST	/store/{id}/tag	Create a new tag.
POST	/item/{id}/tag/{id}	Link an item in a store with a tag from the same store.
DELETE	/item/{id}/tag/{id}	Unlink a tag from an item.
GET	/tag/{id}	Get information about a tag given its unique id.
DELETE	/tag/{id}	Delete a tag, which must have no associated items.

The following table lists the meaning of the locks

Endpoint Status	Description
No Lock	No authentication required.
One 🔒 Lock	Authentication is required. To make a request, the user must have authenticated within the last few days.
Two 🔒🔒Locks	Authentication is required, and the user must have a paid subscription.