Nesta documentação, discutiremos o conceito de Chave API e seu processo de geração na plataforma Zydon. Além disso, exploraremos os procedimentos para revogação e abordaremos considerações importantes sobre a segurança associada às Chaves API.
O que é uma API?
API é a sigla para Application Programming Interface, que em português significa Interface de Programação de Aplicações. Em termos simples, uma API é um conjunto de regras e protocolos que permite que diferentes softwares se comuniquem entre si. Ela define os métodos e formatos de comunicação que os desenvolvedores podem usar para solicitar e fornecer dados ou funcionalidades entre diferentes sistemas de software.
Como gerar uma chave de API
Faça login na plataforma Zydon e vá até a configurações de organização:
Entre na aba Chaves de API e clique em "Adicionar chave de API":
Coloque um nome para sua chave e ao ir para o próximo passo será gerado uma ID e um segredo da chave API, após isso clique em concluir.
Segurança da chave API
A segurança de sua chave API é muito importante, pois ela dará acesso total a sua conta Zydon, proteja ela como se fosse uma senha. Tenha em mente alguns cenários comuns ao trabalhar com chaves de API.
Dê a cada integração sua própria chave de API. Atribua nomes descritivos a cada chave para saber qual chave vai com cada ERP. Se uma chave de API específica for comprometida, você poderá revogá-la sem desativar o acesso às suas outras integrações.
Tenha cuidado para não expor a chave ao público (como em capturas de tela, vídeos ou documentos de ajuda). Vale lembrar que desfocar os dados nem sempre é o suficiente. É melhor remover os dados completamente.
Se precisar compartilhar o acesso à sua conta, gere uma nova chave e nomeie-a para saber qual chave revogar, se necessário. Nunca envie uma chave de API por e-mail. Caso a conta de e-mail seja invadida por hackers, eles poderão acessar também a sua conta na plataforma Zydon.
Para obter mais informações sobre como utilizar as Chaves API ou para assistência adicional, entre em contato com nossa equipe de suporte.