canvaAPI.md

Informações adicionais

Canvas dos WebServices

Item	Objetivo	Ação	Verbo	Parâmetros - Query	Parâmetros - Path	Parâmetros - Corpo	Parâmetros - Cabeçalho	Saída	Url
Categoria	Listar as categorias	Leitura	GET	ordenacao (opcional)			token de autenticação	Lista de Categorias	GET /api/categorias
Categoria	Obter os detalhes de uma categoria	Leitura	GET		id da categoria		token de autenticação	Exibir os dados de uma categoria	GET /api/categorias/{id}
Categoria	Inserir uma nova categoria	Inserção	POST			dados da categoria	token de autenticação	Exibir os dados da categoria inserida	POST /api/categorias
Categoria	Atualizar os dados de uma categoria	Atualização	PATCH		id da categoria	dados da categoria	token de autenticação	Exibir os dados da categoria atualizada	PATCH /api/categorias/{id}
Categoria	Apagar os dados de uma categoria	Exclusão	DELETE		id da categoria		token de autenticação	Exibir os dados da categoria apagado	DELETE /api/categorias/{id}
Clientes	Listar as clientes	Leitura	GET	ordenacao (opcional)			token de autenticação	Lista de Clientes	GET /api/clientes
Clientes	Obter os detalhes de um cliente	Leitura	GET		id do cliente		token de autenticação	Exibir os dados de um cliente	GET /api/clientes/{id}
Clientes	Inserir um novo cliente	Inserção	POST			dados do cliente	token de autenticação	Exibir os dados do cliente inserido	POST /api/clientes
Clientes	Atualizar os dados de um cliente	Atualização	PATCH		id do cliente	dados do cliente	token de autenticação	Exibir os dados do cliente atualizado	PATCH /api/clientes/{id}
Clientes	Apagar os dados de um cliente	Exclusão	DELETE		id do cliente		token de autenticação	Exibir os dados do cliente apagado	DELETE /api/clientes/{id}
Marcas	Listar as marcas	Leitura	GET	ordenacao (opcional)			token de autenticação	Lista de Marcas	GET /api/marcas
Marcas	Obter os detalhes de uma marca	Leitura	GET		id da marca		token de autenticação	Exibir os dados de uma marca	GET /api/marcas/{id}
Marcas	Inserir uma nova marca	Inserção	POST			dados da marca	token de autenticação	Exibir os dados da marca inserida	POST /api/marcas
Marcas	Atualizar os dados de uma marca	Atualização	PATCH		id da marca	dados da marca	token de autenticação	Exibir os dados da marca atualizada	PATCH /api/marcas/{id}
Marcas	Apagar os dados de uma marca	Exclusão	DELETE		id da marca		token de autenticação	Exibir os dados da marca apagada	DELETE /api/marcas/{id}
Produtos	Listar os produtos	Leitura	GET	ordenacao (opcional), filtro (opcional), pagina (opcional)			token de autenticação	Lista de Produtos	GET /api/produtos
Produtos	Obter os detalhes de um produto	Leitura	GET		id do produto		token de autenticação	Exibir os dados de um produto	GET /api/produtos/{id}
Produtos	Inserir um novo produto	Inserção	POST			dados do produto	token de autenticação	Exibir os dados do produto inserido	POST /api/produtos
Produtos	Atualizar os dados de um produto	Atualização	PATCH		id do produto	dados do produto	token de autenticação	Exibir os dados do produto atualizado	PATCH /api/produtos/{id}
Produtos	Apagar os dados de um produto	Exclusão	DELETE		id da produto		token de autenticação	Exibir os dados do produto apagado	DELETE /api/produtos/{id}
Pedidos	Listar os pedidos de um cliente	Leitura	GET	ordenacao (opcional)	id do cliente		token de autenticação	Lista de Pedidos de um cliente	GET /api/clientes/{id}/pedidos
Pedidos	Obter os detalhes de um pedido	Leitura	GET		id do pedido		token de autenticação	Exibir os dados de um pedido	GET /api/pedidos/{id}
Pedidos	Inserir um novo pedido	Inserção	POST		id do cliente	dados do pedido	token de autenticação	Exibir os dados do pedido inserido	POST /api/clientes/{id}/pedidos
Pedidos	Atualizar os dados de um pedido	Atualização	PATCH		id do pedido	dados do pedido	token de autenticação	Exibir os dados do pedido atualizado	PATCH /api/pedidos/{id}
Pedidos	Apagar os dados de um pedido	Exclusão	DELETE		id da pedido		token de autenticação	Exibir os dados do pedido apagado	DELETE /api/pedidos/{id}
Itens do pedido	Listar os itens do pedido	Leitura	GET		id do pedido		token de autenticação	Lista de itens do pedido	GET /api/pedidos/{id}/itensdopedido
Itens do pedido	Obter os detalhes de um item do pedido	Leitura	GET		id do pedido, id do item		token de autenticação	Exibir os dados de um item do pedido	GET /api/pedidos/{iddopedido}/itensdopedido/{iddoitem}
Itens do pedido	Inserir um novo item no pedido	Inserção	POST		id do pedido	dados do item	token de autenticação	Exibir os dados do item inserido	POST /api/pedidos/{id}/itensdopedido
Itens do pedido	Atualizar os dados de um item do pedido	Atualização	PATCH		id do pedido, id do item	dados do item	token de autenticação	Exibir os dados do item atualizado	PATCH /api/pedidos/{iddopedido}/itensdopedido/{iddoitem}
Itens do pedido	Apagar os dados de um item	Exclusão	DELETE		id da pedido, id do item		token de autenticação	Exibir os dados do item apagado	DELETE /api/pedidos/{iddopedido}/itensdopedido{iddoitem}
Segurança	Criar um novo usuário	Inserção	POST			dados do usuário		Exibir os dados do usuário inserido	POST /api/register
Segurança	Login do usuário	Leitura	POST			dados do usuário		token de autenticação	POST /api/login
Segurança	Logout do usuário	Leitura	POST				token de autenticação	Mensagem informativa	POST /api/logout
Segurança	Obter as informações do usuário logado	LEITURA	GET				token de autenticação	Exibir os dados do usuário logado	GET /api/user