Integrações
Documente integrações sempre pelo valor para o negócio: o que passa a funcionar, quem ganha tempo, quais dados passam (em termos funcionais) e o que o usuário percebe na plataforma.
O que documentar nesta seção
- Objetivo da integração: ex.: “passamos a importar colaboradores do sistema X automaticamente”.
- Responsabilidades: qual time configura, qual time opera no dia a dia.
- Suporte: a quem recorrer quando algo não bater.
Evite expor URLs internas, chaves ou nomes de serviços que não dizem nada ao usuário final.
Comunicação com a equipe
| Integração | O que faz |
|---|---|
| Slack | Os avisos de e-mail chegam também por mensagem direta no Slack |
| Discord | Os avisos de e-mail chegam também por mensagem direta no Discord; cada pessoa conecta a própria conta |
Integrações × Senior G5
Documentação técnica comercial (SOAP) para envio ao cliente:
| Integração | Guia | HTML completo |
|---|---|---|
| Admissão digital → folha | Admissão digital × Senior G5 | abrir |
| Férias ← folha (períodos, saldos) | Férias × Senior G5 | abrir |
| Ponto ↔ Controle de Ponto | Ponto × Senior G5 | abrir |
A API pública de integradores é https://api.tagguirh.com.br. A documentação técnica abre pela plataforma, em Configurações → Chaves de API → Ver documentação, com o usuário logado.
Com PDI (leitura) marcado na chave, a integração consulta os planos de cada colaborador e um resumo de status. Não cria nem altera PDI.