Global Health Conecta
API Docs
Bem-vindo à documentação das APIs públicas do Global Health Conecta.
Integre seus sistemas com as soluções de saúde da MV de forma simples e eficiente.
Sobre o Global Health Conecta API Docs
O API Docs do Global Health Conecta centraliza e organiza a documentação completa das APIs públicas oferecidas pela MV Global Health, com o objetivo de facilitar o acesso, a consulta e o consumo das especificações, promovendo agilidade no desenvolvimento de soluções em saúde.
Todas as APIs seguem o padrão OpenAPI 3.0 (Swagger), permitindo visualizar, testar e integrar os endpoints diretamente pela interface ou importar para ferramentas como Postman ou Insomnia.
Objetivo
Facilitar a integração de sistemas externos com a plataforma Global Health, oferecendo:
- Documentação clara e completa de todas as APIs disponíveis.
- Organização por categorias para facilitar a navegação.
- Ambientes de teste (Produção, Homologação e QA), com validação em Homologação e QA antes do uso em Produção.
- Exemplos práticos e modelos de requisição e resposta.
- Suporte técnico para dúvidas e problemas.
Como utilizar as APIs
1. Obtenha sua chave de API
Solicite a x-api-key ao gestor técnico responsável pela sua integração. Sem a chave válida, as requisições não serão autorizadas.
2. Consulte a documentação
Use o menu lateral para escolher a API, explore endpoints, parâmetros, corpos de requisição e respostas esperadas.
3. Teste em Homologação
Use o ambiente de Homologação para validar a integração antes de apontar para Produção.
Estrutura básica de uma requisição
Boas práticas para desenvolvedores
Segurança
- Não exponha chaves de API em repositórios públicos ou código-fonte versionado sem proteção.
- Use variáveis de ambiente ou cofres de segredo para armazenar credenciais.
- Revise periodicamente permissões e notifique imediatamente em caso de comprometimento de chave.
Performance
- Respeite limites de taxa (rate limiting) e políticas de uso descritas na documentação.
- Implemente retentativas com backoff exponencial quando aplicável.
- Faça cache quando fizer sentido e monitore tempos de resposta.
Tratamento de erros
- Trate códigos HTTP (4xx, 5xx) de forma explícita na sua aplicação.
- Registre erros para diagnóstico sem vazar dados sensíveis em logs.
- Em dúvidas sobre mensagens de erro, consulte o responsável técnico ou Avisos e regras de uso.
Desenvolvimento
- Teste sempre em Homologação/QA antes de Produção.
- Valide dados de entrada conforme os contratos da API.
- Mantenha integrações alinhadas às versões documentadas e documente internamente os fluxos críticos.
Categorias de APIs disponíveis
Clinic
APIs para integração com o sistema Clinic, incluindo gestão de agendas, clínicas, prestadores e regulação.
One Touch
APIs para protocolo de entrada e processos simplificados.
Personal Health
APIs para gestão de dados pessoais de saúde, eventos, fichas clínicas, notificações e pendências.
Serviços
APIs para serviços auxiliares, como gestão de beneficiários e reconhecimento facial.
- Use o menu lateral para escolher uma categoria e abrir a documentação Swagger de cada API.
- Consulte a especificação de cada API para entender endpoints, parâmetros e respostas.
- Entre em contato com o responsável técnico para obter sua chave de API (
x-api-key). - Teste suas integrações no ambiente de Homologação antes de Produção.
- Leia Avisos e regras de uso e, em caso de dúvidas, acione o canal de suporte acordado com a MV.
Avisos e regras de uso
Contrato ativo, autenticação com x-api-key, limites de taxa e uso dos ambientes (Produção, Homologação e QA).
As mesmas regras gerais da página inicial — aqui com o detalhe necessário para colocar integrações em Produção com segurança.
Leia antes de integrar
O descumprimento pode resultar em bloqueio de acesso ou rescisão conforme contrato.
Contrato ativo obrigatório
O uso das APIs públicas é condicionado à existência de um contrato ativo com a MV Global Health. Certifique-se de que seu contrato está válido antes de iniciar a integração em Produção.
Autenticação via x-api-key
Todas as requisições devem incluir o cabeçalho x-api-key com a chave fornecida pelo responsável técnico. Chaves inválidas ou ausentes resultam em 401 (Unauthorized).
Limitações de uso
Podem existir limitações de taxa de requisição (rate limiting) para garantir estabilidade do serviço. Por exemplo, a API de Gestão de Beneficiários pode operar com limite da ordem de 1 requisição por segundo; outras APIs podem ter limites distintos — consulte sempre a documentação específica de cada recurso.
Ambientes disponíveis
Em geral, estão disponíveis os ambientes Produção (uso final), Homologação (testes e validação) e QA (garantia de qualidade e testes automatizados). Utilize sempre Homologação para testar antes de migrar integrações para Produção.
Carregando documentação…