A API Indexmed permite que outros sistemas se comuniquem com a plataforma Indexmed de forma automática.
Na prática, ela funciona como uma ponte entre o Indexmed e outros sistemas. Com essa integração, é possível enviar, consultar, atualizar ou excluir informações sem precisar realizar essas ações manualmente na plataforma.
💡 Exemplo: uma empresa pode integrar seu sistema de RH ao Indexmed para enviar automaticamente os dados dos colaboradores, evitando o cadastro manual das mesmas informações.
🚀 O que é possível fazer com a API?
A API permite realizar diferentes tipos de ações, dependendo do recurso integrado:
Consultar informações já cadastradas no Indexmed.
Cadastrar novos dados.
Atualizar informações existentes.
Excluir registros, quando essa operação estiver disponível.
📋 APIs disponíveis
Atualmente, a Indexmed disponibiliza integração para os seguintes recursos:
Arquivos - Permite consultar e gerenciar os arquivos armazenados na Indexmed.
Atestados - Permite consultar e gerenciar os atestados dos colaboradores.
Colaboradores - Permite consultar, cadastrar e atualizar informações dos colaboradores.
Empresa - Permite consultar as informações das empresas cadastradas no Indexmed.
EPI - Permite consultar e gerenciar informações relacionadas aos Equipamentos de Proteção Individual (EPIs).
eSocial - Permite integrar e consultar informações relacionadas aos eventos do eSocial.
Função - Permite consultar e gerenciar as funções cadastradas para os colaboradores.
Grupo - Permite consultar e gerenciar os grupos cadastrados na plataforma.
Ficha Clínica - Permite consultar as informações registradas nas fichas clínicas dos colaboradores.
Lote de Eventos - Permite gerenciar os lotes de eventos relacionados ao eSocial.
Exames - Permite consultar e gerenciar informações sobre os exames dos colaboradores.
Médico – Permite consultar e gerenciar os médicos cadastrados no Indexmed.
Setor - Permite consultar e gerenciar os setores cadastrados na empresa.
📌 Importante: As ações disponíveis podem variar de acordo com cada API. Consulte a documentação específica para verificar quais operações podem ser realizadas em cada recurso.
🔐 Como funciona o acesso?
Para utilizar a API, é necessário possuir dados de acesso específicos, que identificam o usuário e permitem a comunicação segura com o Indexmed.
A autenticação utiliza o padrão Basic Authentication e os dados de acesso estão disponíveis em Meu Perfil, no aplicativo Indexmed.
🔒 Atenção: os dados de acesso à API são individuais e sigilosos. Eles permitem acessar as informações disponíveis na assinatura. Por isso, não compartilhe suas credenciais e mantenha-as em local seguro.
Caso seus dados de acesso sejam expostos ou utilizados indevidamente, entre em contato com o Suporte Indexmed para solicitar a troca da Chave API.
🛡️ Regras de segurança e utilização
Para garantir o funcionamento e a segurança da integração:
A comunicação deve ser feita exclusivamente por HTTPS.
Os dados de acesso devem ser informados corretamente.
É necessário respeitar o limite de requisições da API:
30 requisições por segundo
1.000 por minuto
6.000 por hora
15.000 por dia
100.000 por semana
⚠️ Atenção: Qualquer alteração realizada por meio da API também será refletida no Indexmed. Isso significa que inclusões, alterações e exclusões feitas pela integração têm efeito real na plataforma.
📊 Como saber se uma operação deu certo?
Sempre que uma solicitação é enviada para a API, o Indexmed retorna um código de resposta informando o resultado.
Os principais códigos são:
200: Operação realizada com sucesso.
301: Informação ou recurso foi movido permanentemente.
302: Informação ou recurso foi movido temporariamente.
304: Informação não foi alterada.
401: É necessário corrigir ou informar a autenticação.
403: O acesso não é permitido.
404: Informação ou recurso não encontrado.
405: a operação solicitada não está disponível para aquele recurso.
410: recurso não está mais disponível.
500: ocorreu um erro interno no servidor.
502: ocorreu um erro na comunicação entre servidores.
503: o serviço está temporariamente indisponível.
💡 Em resumo
A API Indexmed facilita a integração entre o Indexmed e outros sistemas, permitindo que informações sejam compartilhadas e atualizadas automaticamente.
Para utilizar uma integração, é necessário ter os dados de acesso e seguir as regras e orientações da documentação técnica de cada API.
Quer saber mais detalhes? Acesse: Indexmed Web Api