API de integração
Quando a administradora já mantém as unidades e os proprietários no próprio sistema, ele pode falar direto com o Vote Assembleia, sem ninguém digitar no painel: cadastrar, atualizar e bloquear unidades votantes e disparar os códigos de acesso. Este artigo é para quem vai pedir a integração ao fornecedor do sistema; os detalhes técnicos ficam na documentação da API.
Como funciona
Seção intitulada “Como funciona”- O síndico gera uma chave de API em Minha conta → Integrações → Chaves de API e entrega ao integrador. A chave age em nome do síndico: vale só para os condomínios dele e pode ser revogada a qualquer momento. Veja Chaves de API.
- O sistema da administradora envia as unidades em lotes, escolhendo o condomínio pelo CNPJ ou pelo identificador. Cada linha traz o bloco, o número, a fração ideal, o CPF ou CNPJ do responsável, o nome, o e-mail, o celular e se a unidade está ativa ou bloqueada para votar.
- O Vote Assembleia confere tudo antes de gravar (CPF e CNPJ com dígito verificador, unidade repetida, limite de unidades contratadas) e só grava se não houver erro.
- Se o integrador pedir, cada unidade nova ou atualizada recebe o código de acesso por e-mail, igual ao envio pelo painel.
O que o integrador consegue fazer
Seção intitulada “O que o integrador consegue fazer”| Operação | O que faz |
|---|---|
| Listar os condomínios | descobre os condomínios do síndico, com o CNPJ e as unidades em uso |
| Listar as unidades | as unidades de um condomínio, com o responsável e a situação |
| Validar | confere um lote sem gravar nada e devolve os erros linha a linha |
| Cadastrar | cria unidades novas; com erro em qualquer linha, nada é gravado |
| Atualizar | muda unidades existentes; pode renovar o código de acesso |
| Cadastrar ou atualizar | o mesmo da importação por planilha: cria o que não existe e atualiza o resto |
| Bloquear ou desbloquear a votação | pelo identificador ou pelo bloco e número |
As regras são as mesmas do painel: o responsável é identificado pelo CPF ou CNPJ e reaproveitado entre os condomínios; trocar o responsável invalida o código de acesso; o limite de unidades contratadas vale. O que a API não faz: enviar planilha (o integrador manda os dados já lidos) e criar votações.
A documentação técnica
Seção intitulada “A documentação técnica”As rotas, os campos e os exemplos estão no Swagger da API, no link Documentação da API do cartão Chaves de API, na parte “Integração externa”. É esse endereço que você passa ao fornecedor do sistema.
Veja também
Seção intitulada “Veja também”Ainda com dúvida?
Mande a sua pergunta pelo formulário do painel ou por e-mail. Conte o que aparece na tela e onde: no painel, no aplicativo ou no site de votação. A resposta chega por e-mail.