API Communy para Clientes
Esta documentação descreve os endpoints disponíveis na API Communy para consulta de dados de condomínios, unidades, condôminos, veículos e dados adicionais.
URL base
https://communy.com.brSegurança
Todos os endpoints exigem autenticação por token no header HTTP Authorization, usando o formato Bearer.
Authorization: Bearer <token_da_api>O token é validado no cadastro de credenciais da API Communy. Para que a requisição seja aceita, a credencial precisa existir e estar habilitada.
Resposta para token ausente, inválido ou desabilitado
{
"error": "Unauthorized",
"code": 401
}Paginação
Os endpoints de listagem aceitam os parâmetros page e limit via query string.
| Parâmetro | Descrição | Padrão | Limite |
|---|---|---|---|
page | Número da página desejada. | 1 | Mínimo 1 |
limit | Quantidade de registros por página. | 100 | Máximo 100 |
Exemplo de paginação
?page=1&limit=100Metadados de paginação
{
"pagination": {
"page": 1,
"limit": 100,
"total_pages": 1,
"total_items": 25,
"has_next": false,
"has_previous": false
}
}Endpoints disponíveis
1. Listar unidades de um condomínio
Retorna as unidades de um condomínio usando o condominium_hash do condomínio.
| Método | GET |
|---|---|
| Endpoint | /api/v1/condominiums/units/{condominium_hash}/ |
| Parâmetro de rota | condominium_hash: hash do condomínio. |
Exemplo de requisição
GET https://communy.com.br/api/v1/condominiums/units/{condominium_hash}/?page=1&limit=100
Authorization: Bearer <token_da_api>Campos retornados em results
| Campo | Descrição |
|---|---|
uuid | Identificador UUID da unidade. |
hash | unit_hash da unidade. |
description | Descrição formatada da unidade. |
unit | Identificação da unidade. |
block | Bloco da unidade. |
number | Número da unidade. |
enabled | Indica se a unidade está habilitada. |
up_to_date | Indica se a unidade está adimplente. |
rented | Indica se a unidade está alugada. |
empty | Indica se a unidade está vazia. |
ideal_fraction | Fração ideal da unidade. |
square_meter | Metragem da unidade. |
receives_normal_invoice | Indica se recebe fatura normal. |
receives_extra_invoice | Indica se recebe fatura extra. |
normal_invoice_due_day | Dia de vencimento da fatura normal. |
extra_invoice_due_day | Dia de vencimento da fatura extra. |
2. Listar condôminos de uma unidade
Retorna os condôminos vinculados a uma unidade usando o unit_hash.
| Método | GET |
|---|---|
| Endpoint | /api/v1/condominiums/units/residents/{unit_hash}/ |
| Parâmetro de rota | unit_hash: hash da unidade. |
Exemplo de requisição
GET https://communy.com.br/api/v1/condominiums/units/residents/{unit_hash}/?page=1&limit=100
Authorization: Bearer <token_da_api>Campos retornados em results
| Campo | Descrição |
|---|---|
uuid | Identificador UUID do condômino. |
name | Nome do condômino. |
email | E-mail principal. |
alternative_emails | E-mails alternativos. |
receive_email | Indica se recebe e-mail. |
type | Código do tipo de condômino. |
type_description | Descrição do tipo de condômino. |
cpf_cnpj | CPF ou CNPJ cadastrado. |
phone | Telefone cadastrado. |
financial_use | Indica se o registro é usado no financeiro. |
automation_status | Status de automação. |
sync_enabled | Indica se a sincronização está habilitada. |
birth_date | Data de nascimento no formato YYYY-MM-DD. |
kinship | Código do grau de parentesco. |
kinship_description | Descrição do grau de parentesco. |
contract_start | Início do contrato no formato YYYY-MM-DD. |
contract_end | Fim do contrato no formato YYYY-MM-DD. |
last_login | Data e hora do último login. |
responsible_voter | Indica se é responsável por votação. |
3. Listar veículos de uma unidade
Retorna os veículos vinculados a uma unidade usando o unit_hash. Apenas veículos não excluídos são retornados.
| Método | GET |
|---|---|
| Endpoint | /api/v1/condominiums/units/vehicles/{unit_hash}/ |
| Parâmetro de rota | unit_hash: hash da unidade. |
Exemplo de requisição
GET https://communy.com.br/api/v1/condominiums/units/vehicles/{unit_hash}/?page=1&limit=100
Authorization: Bearer <token_da_api>Campos retornados em results
| Campo | Descrição |
|---|---|
uuid | Identificador UUID do veículo. |
plate | Placa do veículo. |
model | Modelo do veículo. |
parking | Vaga cadastrada. |
manufacturer | Fabricante do veículo. |
color | Cor do veículo. |
credential_tag | Tag de credencial. |
sync | Indica se está sincronizado. |
camera_list | Lista de câmeras vinculadas. |
4. Listar dados adicionais de uma unidade
Retorna os dados adicionais cadastrados para uma unidade usando o unit_hash.
| Método | GET |
|---|---|
| Endpoint | /api/v1/condominiums/units/additionaldata/{unit_hash}/ |
| Parâmetro de rota | unit_hash: hash da unidade. |
Exemplo de requisição
GET https://communy.com.br/api/v1/condominiums/units/additionaldata/{unit_hash}/?page=1&limit=100
Authorization: Bearer <token_da_api>Campos retornados em results
| Campo | Descrição |
|---|---|
type | Código do tipo de dado adicional. |
type_description | Descrição do tipo de dado adicional. |
description | Valor cadastrado no dado adicional. |
Formato geral de resposta
Todos os endpoints retornam os dados principais dentro da chave results. Quando o endpoint consulta dados de uma unidade, também são retornadas as chaves condominium e unit.
{
"condominium": {
"hash": "hash_do_condominio",
"name": "Nome do Condomínio"
},
"unit": {
"hash": "hash_da_unidade",
"description": "Bloco A Unidade 101",
"unit": "A 101",
"block": "A",
"number": "101"
},
"pagination": {
"page": 1,
"limit": 100,
"total_pages": 1,
"total_items": 1,
"has_next": false,
"has_previous": false
},
"total_items": 1,
"results": []
}Códigos de erro
| HTTP status | Quando acontece |
|---|---|
401 | Token ausente, inválido ou desabilitado. |
404 | Condomínio ou unidade não encontrado. |
405 | Método HTTP diferente de GET. |
Collection Postman
A collection do Postman está disponível aqui.