VSaúde Flow
Central de Ajuda VSaúde Flow
Neste artigo

Criar e gerenciar chaves de API

Chaves de API permitem que uma integração externa use os acessos autorizados da conta.

Como chegar

Menu do usuário → Desenvolvedores → Chaves de API

Antes de começar: Acesso à conta correta e permissão para visualizar ou editar o módulo. Recursos contratados variam por plano.

Como fazer

  1. Abra Desenvolvedores e selecione Chaves de API.
  2. Clique em Nova chave e informe um nome que identifique a integração.
  3. Selecione os escopos necessários e a validade, quando aplicável.
  4. Crie a chave e entregue-a ao responsável técnico por meio seguro.
  5. Consulte a documentação da API em /docs/api para implementar a integração usando as operações descritas.
  6. Para retirar acesso, revogue a chave correspondente.

O que você precisa saber

  • A área depende de recurso de plano e permissões administrativas.
  • Uma chave sem escopos não executa operações.
  • Trocar uma chave requer atualizar o sistema que a utiliza antes de revogar a anterior.

Se não funcionar

  • Integração recebe acesso negado: confira validade, revogação e escopos, sem expor o valor da chave em chamados.