freesewing/markdown/dev/reference/backend/en.md

title	for	about
Backend API	developers	Documentation for our backend REST API

This documentation is outdated

See also: The backend documentation

API Cheat sheet

With authentication:

🔐	Method	Endpoint	Description
🔐	POST	/models	Creates model
🔐	GET	/models/:handle	Read model
🔐	PUT	/models/:handle	Update model
🔐	DELETE	/models/:handle	Remove model
🔐	POST	/recipes	Create recipe
🔐	GET	/recipes/:handle	Read recipe
🔐	PUT	/recipes/:handle	Updates recipe
🔐	DELETE	/recipes/:handle	Remove recipe
🔐	GET	/account	Load account
🔐	PUT	/account	Update account
🔐	DELETE	/account	Remove account
🔐	POST	/account/change/email	Confirm email change
🔐	GET	/account/export	Export account
🔐	GET	/account/restrict	Restric account
🔐	GET	/users/:username	Read user profile
🔐	POST	/available/username	Is username available

Without authentication:

🔓	Method	Endpoint	Description
🔓	POST	/signup	Request account
🔓	POST	/account	Create account
🔓	POST	/login	Log in
🔓	POST	/reset/password	Recover password
🔓	POST	/confirm/login	Passwordless login
🔓	POST	/oauth/init	Oauth initialisation
🔓	GET	/oauth/callback/from/:provider	Oauth callback
🔓	POST	/oauth/login	Oauth login
🔓	GET	/patrons	Patron list