Integrações
API e avisos automáticos
Sistemas da organização se ligam à plataforma com chave por escopo e recebem avisos assinados.
Nenhuma integração dá acesso a denúncias nem à identidade de quem relatou.
Autenticação
Chave por escopo
- A administração da organização cria a chave em Configurações, aba Integrações, e escolhe os escopos.
- Cada chamada leva a chave no cabeçalho Authorization (Bearer).
- A chave é guardada só em resumo SHA-256 e pode ser revogada a qualquer momento.
- Limite de 120 chamadas por minuto em cada chave.
Escopos
O que cada escopo permite
- IndicadoresGET /api/v1/indicadores
Números agregados do período, da Ouvidoria e da Privacidade. Sem denúncias, nem em número.
- Lista de casosGET /api/v1/manifestacoes
Só dados de controle: número interno, canal, assunto, unidade, situação e datas. Sem o relato e sem identificação.
- Registrar casosPOST /api/v1/registrar
Um sistema autorizado, como WhatsApp ou central telefônica, envia o relato e recebe o protocolo e a chave para repassar a quem relatou. Nada do caso volta pela API.
- Relação mensal de queixasGET /api/v1/simas
Relação do mês para prestação de contas: número, unidade, categoria, datas e resultado da análise. Sem dados pessoais.
- Agente VirtualConector da Agente Virtual
Lê os casos sem dados pessoais e envia sugestões, que ficam pendentes até a aprovação de uma pessoa.
Avisos automáticos
Avisos assinados
A plataforma avisa o sistema da organização quando acontece:
- Manifestação registrada
- Situação alterada
- Resposta enviada
- Prazo próximo
- Prazo vencido
- Incidente registrado
- Relatório aprovado
- Cada aviso vai assinado com HMAC-SHA256, para quem recebe conferir a origem.
- Só endereços públicos com HTTPS; endereços da rede interna são recusados.
- Os avisos não levam o conteúdo dos relatos, e as denúncias não geram avisos.
- Se o sistema não responder, novas tentativas em 1, 5, 30, 120 e 720 minutos.
Especificação
Documentação técnica
A especificação completa, no padrão OpenAPI 3.1, fica na área da equipe de cada organização e é entregue à equipe técnica na implantação.
Pedir a especificação