Autenticação

A autorização de Acesso à Web API Indexmed é gerenciada através do modelo Basic Authentication.

Basic Authentication

O Basic Authentication é o sistema de autenticação mais comum do protocolo HTTP. Ele é incluído no header da requisição HTTP da seguinte maneira:

Authorization: Basic {credenciais em base 64 no formato usuário:senha}

Ressaltamos que o Base 64 é um esquema de codificação e não criptografia. Sendo assim, você DEVE utilizá-lo somente com uma conexão HTTPS (TLS). Por esta razão a API IndexMed não aceita conexões apenas neste contexto.

Workflow

O esquema de autenticação ocorre da seguinte maneira:

  • O cliente envia uma solicitação, se esta solicitação não contém as credencias ou não atende às regras do serviço, o servidor responde ao cliente com o código HTTP 401 (Unauthorized) e com um cabeçalho WWW-Authenticate, que dá informações de como se autenticar.
  • O cliente envia o request com o header de autenticação, mostrado acima. Se as credenciais estiverem corretas, receberá uma resposta diferente de 403 (Forbidden). Esta resposta vai varia de acordo com o método utilizado, você pode clicar aqui para ver a lista de métodos e status de resposta.

Credenciais de acesso

Para acessar as APIs do App IndexMed é necessário que seja um usuário ativo utilizando uma assinatura ativa.

Os dados que serão enviados para solicitar o acesso são os seguintes: ID Usuário [nvarchar(9)] e Chave API [char(32)]

Authorization: Basic {credenciais em base 64 no formato ID Usuário:Chave API}

Estes dados de acesso a API são individuais por usuário e estão disponíveis na área Meu Perfil do App IndexMed. Atenção: Estes dados são sigilosos e dão acesso à toda informação disponível na sua assinatura, mantenha os em um lugar seguro. E caso acredite que tenha exposto indevidamente estes dados, entre em contato com nosso suporte (https://www.indexmed.com.br/app/central-de-ajuda) para solicitar a troca da sua Chave API.

Atenção: A configuração de acesso à API é inicialmente BLOQUEADA por padrão para todos os usuários do aplicativo. Para ativar o acesso à Web Api com suas credenciais acesse o aplicativo, vá até seu Perfil » Dados de Acesso API.

Para realizar testes de acesso aconselhamos o uso da nossa ferramenta para Desenvolvedores: