​
Autenticação na API

A segurança é uma prioridade em nossa plataforma, e a autenticação é necessária para acessar os endpoints da API do GatewayFy. Este documento fornece todas as informações necessárias para você entender e implementar a autenticação corretamente.

​
Obtenção de Credenciais

Para utilizar nossa API, você precisa de credenciais válidas, que incluem uma chave pública e uma chave privada. Estas credenciais podem ser obtidas através do painel de controle de sua conta no GatewayFy.

​
Como Obter suas Credenciais

  1. Acesse o Painel de Controle: Entre no seu perfil no site do GatewayFy.
  2. Navegue até a Seção Gateway: Localize a opção de gerenciamento de Gateway no menu ou painel de controle.
  3. Gerar Credenciais: Se você ainda não possui credenciais ou precisa de um novo conjunto, selecione a opção ‘Gerar/Regenerar credenciais’.
  4. Salvar Credenciais: Uma vez geradas, suas chaves serão exibidas. Copie e guarde-as em um local seguro. A chave privada não será mostrada novamente e você precisará regerar um novo par de chaves caso perca a atual.

​
Uso das Credenciais para Autenticação

Depois de obter suas chaves, você as utilizará para autenticar as requisições feitas à API. As chaves devem ser incluídas nos cabeçalhos de cada requisição HTTP enviada.

​
Autenticando Requisições

  • Chave Pública (x-public-key): Deve ser enviada como parte dos cabeçalhos para identificar sua conta.
  • Chave Privada (x-secret-key): Usada para verificar a autenticidade da requisição.
x-public-key: SUA_CHAVE_PUBLICA_AQUI
x-secret-key: SUA_CHAVE_PRIVADA_AQUI

​
Boas Práticas de Segurança

  • Segurança de Chaves: Nunca compartilhe suas chaves privadas. Armazene-as de maneira segura e trate-as como senhas.
  • Conexão Segura: Utilize sempre HTTPS para garantir que suas requisições sejam criptografadas.
  • Monitoramento: Monitore regularmente o acesso à sua API para detectar qualquer atividade suspeita.

​
Perguntas Frequentes

​
Suporte e Dúvidas

Se você tiver qualquer dúvida sobre como gerar ou usar suas credenciais, ou enfrentar problemas com a autenticação, entre em contato com nosso suporte técnico através do email [email protected] ou pelo whatsapp (11) 9 1798-2825

IntroduçãoTratamento de erros