Use a autenticação OAuth para acessar a API Bricsys 24/7

Visão Geral

Para aumentar a segurança e garantir acesso contínuo à nossa plataforma, todas as aplicações externas devem ser autenticados usando o OAuth.

Dependendo de como sua aplicação interage com nosso sistema, você deve usar um dos seguintes fluxos de OAuth:

  • Fluxo de Código de Autorização: se o usuário necessita fazer Log In para acessar seus próprios dados.
  • Fluxo das Credenciais do Cliente: se a aplicação age de forma independente, sem intervenção do usuário.

Este guia explica como fazer a transição para o OAuth e a informação necessária para registrar sua aplicação com nosso provedor de identidade.

Usar o Fluxo de Código da Autorização (Para Acesso Base-no-Usuário)

Se sua aplicação exige que o usuário autentique e acessem os próprios dados, você deve implementar o Fluxo de Código de Autorização.

Etapas para implementar
  1. Redirecione os usuários ao nosso servidor de autorização para solicitar um código de autorização.
  2. Usuários autenticam usando suas credenciais.
  3. Sua aplicação troca o código de autorização por um token de acesso.
  4. O token de acesso é então usado para acessar nossas APIs em nome do usuário.

Veja também a documentação do Fluxo de Código de Autorização.

Informação necessária para o registro do cliente OAuth
Para registrar sua aplicação, forneça os seguintes detalhes:
  • Nome da Aplicação: adicione um nome exclusivo para identificar sua aplicação.
  • Descrição: adicione uma descrição do uso da sua aplicação para a API Bricsys 24/7.
  • Pessoa de contato técnico: adicione um nome e eMail.
  • Redirecionar URL(s): adicione a(s) URL para onde as respostas de autorização serão enviadas.

Usando o Fluxo das Credenciais do Cliente (Para Acesso Máquina-a-Máquina)

Se sua aplicação não exige autenticação do usuário e age por conta própria (por exemplo, serviços em segundo plano, scripts automatizados), use o Fluxo das Credenciais do Cliente.

Etapas para implementar
  1. Sua aplicação solicita um token de acesso diretamente do nosso servidor de autorização, usando suas credenciais de cliente.
  2. Se a autenticação é bem-sucedida, um token de acesso é retornado.
  3. O token de acesso é usado para interagir com nossas APIs.

Veja também a documentação do Fluxo das Credenciais do Cliente.

Informação necessária para o registro do cliente OAuth
Para registrar sua aplicação, forneça os seguintes detalhes:
  • Nome da Aplicação: adicione um identificador exclusivo para sua aplicação.
  • Descrição: adicione uma descrição do uso da sua aplicação para a API Bricsys 24/7.
  • Pessoa de contato técnico: adicione um nome e eMail.
  • Nome da conta de serviço: adicione o endereço de eMail da conta Bricsys 24/7 que você pretende usar como uma conta de serviço.
    Nota: Você não será capaz de fazer Log In usando esta conta.

Recursos Gerais do OAuth

Para uma compreensão mais profunda do OAuth e sua implementação, consulte os seguintes recursos:

Próximas Etapas

  1. Escolha o fluxo OAuth apropriado com base nas necessidades de sua aplicação.
  2. Reúna os detalhes de registro necessários.
  3. Entre em contato com nossa equipe de suporte por meio de uma Support Request (Solicitação de Suporte) para enviar os detalhes de sua aplicação.
  4. Implemente o fluxo de autenticação em sua aplicação.

Se precisar de mais assistência, preencha uma Solicitação de Suporte na categoria Bricsys 24/7 > API & integração ou entre em contato diretamente com sales@bricsys247.com. Estamos aqui para ajudar!