Sobre Chaves de API | Zydon Help Desk

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 no botão Adicionar chave de API:

Insira um nome para sua chave. Ao avançar para o próximo passo, serão gerados um ID e um segredo da chave API. Após conferir os dados, clique em concluir.

SEGURANÇA DA CHAVE API:

A segurança de sua chave API é fundamental, pois ela concede acesso total à sua conta Zydon. Proteja-a com o mesmo rigor de uma senha. Observe as seguintes recomendações:

Chaves individuais: Dê a cada integração sua própria chave de API. Atribua nomes descritivos para identificar qual chave pertence a cada ERP ou sistema. Caso uma chave seja comprometida, você poderá revogá-la sem afetar as demais integrações.

Exposição pública: Tenha cuidado para não expor a chave em capturas de tela, vídeos ou documentos de ajuda. Lembre-se que desfocar os dados pode não ser suficiente; o ideal é removê-los completamente.

Compartilhamento seguro: Se precisar compartilhar o acesso, gere uma nova chave específica. Nunca envie uma chave de API por e-mail. Se a conta de e-mail for invadida, terceiros poderão acessar sua conta na plataforma.

Observação: Para obter mais informações sobre como utilizar as Chaves API ou para assistência adicional, entre em contato com nossa equipe de suporte.

🚀 Quer integrações seguras e simples? Teste grátis por 15 dias!

Crie sua conta agora: https://admin.zydon.com.br/criacao-conta