Guia de integração

Autenticação

Escolha um modelo de acesso seguro e mantenha o controle das integrações vinculadas ao seu usuário.

A API Indexmed aceita Basic Authentication e Bearer token durante a transição. Para novas integrações, utilize Bearer token.

Transição de autenticação: o Basic Authentication continuará disponível até 1º de abril de 2027. Até essa data, as integrações atuais permanecem funcionando na mesma versão da API. Depois disso, as integrações deverão utilizar Bearer token.

Bearer token (recomendado)

O Bearer token é emitido para uma integração específica e tem duração limitada. Cada integração pode ser revogada sem afetar as demais e recebe somente permissões que o usuário responsável já possui no aplicativo.

  1. No App Indexmed, acesse Meu Perfil » Integrações API.
  2. Crie uma integração, informe o sistema consumidor e selecione os acessos de consulta e gravação necessários.
  3. Guarde as credenciais apresentadas no momento da criação em local seguro.
  4. Envie o token de acesso em cada requisição:
Authorization: Bearer {access_token}

Quando o token de acesso expirar, solicite um novo par de tokens usando o refresh token na rota POST /api/Autenticacao/Token. O refresh token é renovado a cada uso; não o armazene no navegador nem o exponha em logs.

Regras de acesso

A autenticação confirma a identidade da integração, mas não amplia o acesso do usuário. A API aplica as mesmas permissões da plataforma para consultar, incluir e alterar, além dos limites de assinatura, empresa e unidade quando aplicáveis.

Basic Authentication (legado)

O Basic Authentication permanece disponível apenas para manter as integrações existentes durante o período de transição. Planeje a migração para Bearer token antes de 1º de abril de 2027.

Authorization: Basic {credenciais em base 64 no formato ID Usuario:Chave API}

As credenciais Basic são individuais e ficam em Meu Perfil » Integrações API » Integração Basic Authentication. O Base64 é uma codificação, não uma criptografia: use sempre HTTPS e não compartilhe a Chave API.

Atenção: o acesso à API pode estar bloqueado para o usuário. A ativação e as permissões devem ser configuradas no aplicativo antes do primeiro uso.

Para consultar as rotas, os limites e testar as duas formas de autenticação, acesse a área do desenvolvedor.