Gerenciamento de Departamentos na API V3

Neste artigo, você aprenderá a gerenciar os departamentos cadastrados no Ideris. Essa funcionalidade permite criar, visualizar, atualizar e deletar departamentos para controle interno de sua operação.

Endpoints Disponíveis para Departamentos

1. Buscar Departamento pelo ID

• URL: https://apiv3.ideris.com.br/department/{departmentId} 
• Método: GET
• Objetivo:
  Retorna os detalhes de um departamento específico, utilizando o ID como filtro.

2. Listar todos os Departamentos

• URL: https://apiv3.ideris.com.br/department/search 
• Método: GET
• Objetivo:
  Retorna uma lista com todos os departamentos cadastrados, sem a necessidade de filtros.

3. Cadastrar um novo Departamento

• URL: https://apiv3.ideris.com.br/department 
• Método: POST
• Objetivo:
  Cria um novo departamento na base de dados do Ideris.

4. Atualizar um Departamento existente

• URL: https://apiv3.ideris.com.br/department 
• Método: PUT
• Objetivo:
  Atualiza os dados de um departamento já cadastrado.

5. Deletar um Departamento pelo ID

• URL: https://apiv3.ideris.com.br/department/{departmentId} 

• Método: DELETE
• Objetivo:
  Remove um departamento da base de dados, utilizando o ID como filtro.

Atenção 

• Certifique-se de que o departamento a ser deletado é o correto.
• Uma vez excluído, o registro não poderá ser recuperado, pois não há "lixeira" disponível.

Orientações Importantes

• Certifique-se de preencher os campos obrigatórios conforme a documentação disponível no Swagger.
• Use os endpoints com moderação e dentro das regras de throttling da API (limite de requisições por minuto).

Documentação Eletrônica

A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.

• Acesso: Não é necessário token para consultar essa documentação.
• Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.

Se precisar de mais ajuda com este processo, nossa equipe de suporte está pronta para atender você. É só clicar no ícone do whatsapp no canto inferior direito de qualquer página do seu painel Ideris ou abrir um ticket. 

Conte sempre conosco. Até a próxima!