A API Indexmed permite que outros sistemas se comuniquem com a plataforma Indexmed de forma automática e segura.

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.

💡 Um exemplo prático

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 nos dois sistemas.

🚀 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.

📌 Importante: as operações disponíveis podem variar de acordo com cada API. Consulte a documentação específica para verificar quais ações podem ser realizadas em cada recurso.

📋 APIs disponíveis

Atualmente, a Indexmed disponibiliza integração para os seguintes recursos:

API	O que permite fazer
Estrutura Organizacional	Permite integrar informações relacionadas à estrutura organizacional cadastrada no Indexmed.
Atendimento Clínico	Permite integrar informações relacionadas aos atendimentos clínicos realizados na plataforma.
Afastamento	Permite integrar informações relacionadas aos afastamentos dos colaboradores.
Atestado	Permite consultar e gerenciar os atestados dos colaboradores.
Profissional da Saúde	Permite integrar informações dos profissionais da saúde cadastrados no Indexmed.
Médico Coordenador	Permite integrar informações relacionadas aos médicos coordenadores.
Profissionais de Segurança	Permite integrar informações dos profissionais responsáveis pelas atividades de Segurança do Trabalho.
GHE	Permite integrar informações dos Grupos Homogêneos de Exposição utilizados no gerenciamento dos riscos ocupacionais.
Inventário de Risco	Permite integrar informações relacionadas aos riscos e perigos registrados no Inventário de Riscos.
Plano de Ação	Permite integrar informações relacionadas aos planos de ação para prevenção e controle dos riscos.
EPI	Permite consultar e gerenciar informações relacionadas aos Equipamentos de Proteção Individual (EPIs).
Máquinas e Equipamentos	Permite integrar informações relacionadas às máquinas e equipamentos cadastrados na plataforma.
Equipamentos da Brigada de Incêndio	Permite integrar informações dos equipamentos e sistemas utilizados pela Brigada de Incêndio.
Eventos e Treinamentos	Permite integrar informações relacionadas aos eventos e treinamentos cadastrados no Indexmed.
Arquivos	Permite consultar e gerenciar os arquivos armazenados na Indexmed.
eSocial	Permite integrar e consultar informações relacionadas aos eventos do eSocial.
Informar Exames	Permite integrar informações relacionadas aos exames realizados pelos colaboradores.
Importar Ficha Clínica	Permite importar informações de fichas clínicas para a plataforma.
Importar Lotes e Eventos	Permite importar lotes de eventos relacionados ao eSocial.
Tabelas Complementares	Permite integrar informações relacionadas às tabelas complementares utilizadas pela plataforma.
Colaboradores	Permite consultar, cadastrar e atualizar informações dos colaboradores.
Empresa	Permite consultar as informações das empresas cadastradas no Indexmed.
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.

💡 Dica Indexmed: antes de desenvolver uma integração, consulte a documentação da API que será utilizada para entender quais campos, parâmetros e operações estão disponíveis para aquele 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 → Chave API

🔒 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, siga estas orientações:

🔒 Comunicação segura

A comunicação deve ser realizada exclusivamente por HTTPS.

🔑 Dados de acesso

Os dados de autenticação devem ser informados corretamente e mantidos em segurança.

⏱️ Limite de requisições

É necessário respeitar os limites de requisições da API:

30 requisições por segundo

1.000 requisições por minuto

6.000 requisições por hora

15.000 requisições por dia

100.000 requisições por semana

⚠️ Atenção: o excesso de requisições pode comprometer o funcionamento da integração. Respeite os limites estabelecidos pela API.

⚠️ Atenção às alterações realizadas pela API

Qualquer alteração realizada por meio da API também será refletida no Indexmed.

Isso significa que inclusões, alterações e exclusões realizadas pela integração possuem efeito real na plataforma.

Por isso, antes de colocar uma integração em produção, certifique-se de que as configurações e operações foram validadas corretamente.

📊 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 HTTP, indicando o resultado da operação.

Confira os principais códigos:

Código	Significado
200	Operação realizada com sucesso
301	Informação ou recurso movido permanentemente
302	Informação ou recurso 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	O 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

💡 Dica: Ao identificar um erro, verifique 

Se os dados de autenticação estão corretos;

Se o recurso informado existe;

Se a operação está disponível para aquela API;

Se a integração está respeitando os limites de requisições;

Se o serviço está disponível.

🎯 Em resumo

A API Indexmed facilita a integração entre o Indexmed e outros sistemas, permitindo que informações sejam compartilhadas, consultadas e atualizadas automaticamente, de acordo com as operações disponíveis em cada recurso.

Para utilizar uma integração, é necessário ter os dados de acesso, seguir as regras de segurança e consultar a documentação técnica específica de cada API.

🚀 Dica Indexmed: A API é uma grande aliada para automatizar processos e reduzir o retrabalho. Antes de integrar, identifique quais informações precisam ser compartilhadas e confira na documentação quais operações estão disponíveis para cada recurso.

📚 Quer saber mais?

Para consultar a documentação técnica e conhecer os detalhes das APIs disponíveis, acesse a Indexmed Web Api