API de Unidade

A API de Unidade permite gerenciar as unidades (empresas, departamentos ou locais) no sistema Accessus. Unidades são utilizadas para organizar e agrupar acessos.

Visão Geral

Método	Endpoint	Descrição
POST	/unities	Criar nova unidade

Base URL

Todos os endpoints utilizam o prefixo: /accessus/api/v1

---

Cadastro

Criar Unidade

Cadastra uma nova unidade no sistema.

POST/accessus/api/v1/unities

Autenticação

Requisito	Valor
Autenticação	Obrigatória
Permissão	PERM_API_WRITE_UNITY
Content-Type	application/json

Corpo da Requisição

Campo	Tipo	Obrigatório	Descrição
name	string	✓	Nome da unidade
key	string	✓	Chave única de identificação (ex: CNPJ)

Chave Única

A key é um identificador único para a unidade. Recomenda-se utilizar o CNPJ da empresa ou outro código que a identifique de forma exclusiva.

Exemplo de Requisição:

{
  "name": "TOPTIC TECHNOLOGY LTDA",
  "key": "27163586000161"
}

Respostas

✅ 201 CREATED - Unidade criada com sucesso

{
  "id": 7,
  "name": "TOPTIC TECHNOLOGY LTDA",
  "key": "27163586000161"
}

❌ 400 BAD REQUEST - Chave já existente

{
  "status": 400,
  "message": "Key 11111111111 already exists.",
  "path": "/accessus/api/v1/unities/"
}

---

Permissões

Para habilitar as permissões necessárias para utilizar esta API, acesse: Atribuir Permissões ao Papel

Permissão	Descrição
PERM_API_WRITE_UNITY	Permite criar e editar unidades

Atenção

Após habilitar uma permissão no menu Papel, realize o logout do sistema e reinicie a aplicação para que as alterações tenham efeito.