Como usar a API Open do Alertify

Como usar a API Open do Alertify

Bem-vindo à documentação do desenvolvedor do Alertify, onde você encontrará tudo o que precisa para entender e usar nossa API Open. Isso inclui:

  • Autenticação: Saiba como fazer login e acessar com segurança a API.

  • Visão geral do Alertify Architecture: Obtenha uma compreensão clara de como nosso sistema está estruturado.

  • Especificação da API: Informações detalhadas sobre como usar a API de forma eficaz.

Para acessar a API Open do Alertify, visite:https://api.alertify.io/openapi/


A API Open do Alertify é uma API baseada em token que permite criar integrações personalizadas com seus próprios aplicativos ou Sistema de Gerenciamento de Propriedades.


Etapa 1: Gerar uma chave de API no painel do Alertify

Criar uma chave de API é simples. Você pode gerar várias chaves, que permitem obter tokens de autenticação para acessar diferentes pontos de extremidade da API.


Siga estes passos fáceis para gerar sua primeira chave de API:


  1. Faça login no painel do Alertify emhttps://dashboard.alertify.io/authentication/login

  2. Ir para"Configurações"sobre o menu


  1. Então clique em 'Api' no menu superior


  1. O, clique em 'Adicionar nova chave'


  1. Dê um nome à sua API e clique em"Adicionar"


Etapa 2: obter um token de API na API Abrir do Alertify

Depois de ter uma chave Api, você pode usá-la para obter um token de autenticação. Isso permite que você acesse com segurança vários endpoints de API.


(1) Vá para o seguinte link:https://api.alertify.io/openapi/


(2) Em seguida, role para baixo até "Autenticação" na barra de navegação esquerda



(3) Em 'Obter token da API', clique no botão 'Preencher Exemplo' e cole sua tecla API no painel Alertify onde está o texto 'String', para que pareça o seguinte:



(4) Em seguida, clique no botão "Tentar". Seu código de API aparecerá em texto verde. Copie o texto verde somente sem aspas.


(5) Depois que sua chave de API for copiada, role até o topo para 'Autenticação', adicione 'Bearer' com um espaço e cole sua chave de API na pequena caixa de texto e clique em "Atualizar". Isso lhe dará acesso a vários endpoints de API no painel.




É isso - você está tudo feito!


Precisa de assistência adicional?

Se você encontrar algum problema ou precisar de mais assistência, não hesite em entrar em contato com nossa equipe de suporte dedicada em[email protected]. Estamos aqui para ajudá-lo a aproveitar ao máximo sua experiência Alertify.