1. Exemplo do json:
[ { "codigo": 123, "descricao": "BASICA", "categoria": "B", "codigo_externo": "12", "ativo": "S" } ]
Campos:
codigo: Código do registro no banco de dados do CRM
descricao: Descrição da categoria;
categoria: Abreviação da categoria
codigo_externo: Código da categoria no sistema integrado;
ativo: Campo para indicar se a categoria está ativa (S) ou inativa (N)
Todos os endpoints, com exceção do deletar, retornam o json nesse formato.
2. Endpoints
2.1 - Buscar Categoria pelo código
Endpoint: /semente-categoria
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da categoria no banco de dados do CRM.
codigoExterno: Tipo: String. Código da categoria no banco de dados do sistema integrado
Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.
Resposta: Status 200 - Retorna a categoria no formato documentado na sessão Exemplo do json
2.2 - Buscar todas as categorias
Endpoint: /semente-categoria/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das categorias no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar categoria
Endpoint: /semente-categoria
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova categoria não informe o campo “codigo”;
Para editar uma categoria já existente informe o campo “codigo” com o código da categoria que deseja editar;
Resposta: Status 200 - Retorna a categoria cadastrada, no formato documentado na sessão Exemplo do json
2.4 - Inativar uma categoria
Não é possível deletar uma categoria, apenas inativar, pois a categoria pode ter vinculo com pedidos e produtos. Nesse caso, a categoria continua no banco de dados porém com o status inativo.
Endpoint: /semente-categoria
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da categoria no banco de dados do CRM.
codigoExterno: Tipo: String. Código da categoria no banco de dados do sistema integrado, caso existir.
Resposta: Status 200 - Mensagem: Registro inativado com sucesso.
2.5 - Retornar os metadados da categoria
Endpoint: /semente-categoria/metadados
Tipo: get
Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável
Resposta: Status 200 - Retorna um json com as informações dos campos da categoria
2.6 - Pesquisar
Endpoint: /semente-categoria/pesquisa
Tipo: post
Notas:
Esse endpoint retorna as categorias baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
{ "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "descricao", "comparacao": "CONTEM", "valor": "2" } ], "ordenacao": [ { "campo": "categoria", "ordenacao": "ASC" } ] }
Nesse exemplo, estamos filtrando todas as categorias cuja descrição possua o texto “VIASOFT”, também estamos ordenando os registros pela descrição de forma ascendente.