--- title: "Integrações: chaves de API" description: "Como criar, copiar e revogar chaves de API para integrações da clínica (chatbot, sistemas parceiros) e como funciona a chave do WPaciente do agendamento online." url: https://ajuda.wsaudebr.com.br/pt-br/articles/151-integracoes-chaves-de-api collection: "Administração e Configurações" updated: 2026-11-02 language: pt-br --- # Integrações: chaves de API Como criar, copiar e revogar chaves de API para integrações da clínica (chatbot, sistemas parceiros) e como funciona a chave do WPaciente do agendamento online. As **chaves de API** permitem que sistemas de fora do WSaúde, como um chatbot de agendamento ou o sistema de um parceiro, acessem os dados da clínica com segurança. Cada chave tem um nome, vale só para as unidades escolhidas e pode ser revogada a qualquer momento. O agendamento online (WPaciente) também usa uma chave, criada automaticamente. ## Quem pode usar Disponível apenas para administradores da clínica (perfil Administrador em **Administração › Permissões**). Criar chaves depende do recurso adicional **API aberta**, que o dono da conta contrata em **Administração › Minha assinatura**, aba **Recursos adicionais**. Sem o recurso, ao clicar em **Criar chave** aparece "Criar chaves de API depende do recurso API aberta.", com a indicação de onde contratar. Se o recurso for cancelado, as chaves criadas pela clínica são revogadas quando ele termina. A chave do agendamento online (WPaciente) continua valendo. ## Onde fica No menu lateral, no rodapé, acesse **Configurações › Preferências** e abra a aba **Integrações**. O bloco **Chaves de API** fica abaixo de **Agendamento online (WPaciente)**. ![](https://files.gleap.io/pf/gattachments/67104ed4ec989a4095f8eb2b-xAPh9E1OzAtExK8XoGvypgXohbb1nFa4BYCkNAaqZa4K04GdUuMHyt6dfSQP15xeGalZOXFfZIg.png?v=1&k=a&s=api&e=1793707200&sig=5EpHye4uD6xoGN26KncHZVKRJxidIpmG2TqtCeCyMjQ) A tabela mostra, para cada chave: - **Nome**, com o início da chave logo abaixo, para identificá-la sem mostrar o restante; - **Tipo**: **API de terceiros** (criada por você) ou **WPaciente** (a do agendamento online); - **Unidades** que a chave acessa (**Todas**, na do WPaciente); - **Criada**: a data e quem criou (**Sistema**, quando foi gerada automaticamente); - **Último uso**: quando a chave foi usada pela última vez; - **Situação**: **Ativa** ou **Revogada** (com a data e quem revogou); - **Ações**: **Regenerar chave** (só na do WPaciente) e **Revogar chave**. ## Passo a passo: criar uma chave 1. Clique em **Nova chave de API**. 2. Em **Nome:**, dê um nome que identifique quem vai usar a chave (por exemplo, "Chatbot de agendamento"). 3. Em **Unidades que a chave acessa:**, escolha uma ou mais unidades. A integração só enxerga os dados dessas unidades. 4. Clique em **Criar chave**. ![](https://files.gleap.io/pf/gattachments/67104ed4ec989a4095f8eb2b-unUPVFE5RDlOHTAnrIss3xdFch5ouDw4c7V1h09LczbCpxhr58Q0FNVnbE2G4Qdn6ddE4rm3hBv.png?v=1&k=a&s=api&e=1793707200&sig=2xPlaA94vg-03ECu_l5AV4t36uxkd_sLOsIVD2V0PGQ) 5. A janela mostra a chave completa, com o aviso "Copie a chave agora: ela não será mostrada de novo. Se perder, revogue esta e crie outra." Clique no ícone de copiar ao lado da chave e entregue-a, por um canal seguro, a quem vai configurar a integração. Como a própria janela indica, a chave vai no cabeçalho **API-TOKEN** das chamadas. 6. Clique em **Já copiei**. A chave aparece na tabela como **Ativa**. ![](https://files.gleap.io/pf/gattachments/67104ed4ec989a4095f8eb2b-hXQpDu4mnFe4IvPLDxbGoHJzKyHF8TlctHTiEpR0xaF3I8O2muhE7V8y451zUEfyz9kLe8q6Ea9.png?v=1&k=a&s=api&e=1793707200&sig=eQC5B2nkBFw9Y1KR6dF9Ko-I-6CdOiHB5N9WL3yGKWI) ## Revogar uma chave 1. Na linha da chave, clique em **Revogar chave**. 2. Confirme em **Sim, revogar**. Quem usa a chave perde o acesso na hora, e a ação não pode ser desfeita. O sistema mostra "Chave revogada." e a chave continua na tabela, como **Revogada**. Para a integração voltar a funcionar, crie uma chave nova e entregue-a ao responsável. ## A chave do WPaciente (agendamento online) - É criada automaticamente quando o administrador ativa o agendamento online, com acesso a **Todas** as unidades. Não é possível criá-la manualmente. - **Regenerar chave** troca a chave sem desligar o agendamento online. Na janela **Regenerar chave do WPaciente**, clique em **Sim, regenerar**: uma chave nova é enviada ao WPaciente e a atual é revogada. Se o WPaciente não aceitar a chave nova, o sistema avisa "Não foi possível enviar a chave nova ao WPaciente." e a chave atual continua valendo. - **Revogar chave** desliga o agendamento online, e a página pública deixa de aceitar agendamentos. Para voltar, ative o agendamento online de novo no bloco **Agendamento online (WPaciente)**; uma chave nova é criada. ![](https://files.gleap.io/pf/gattachments/67104ed4ec989a4095f8eb2b-zOVXq65cNX5c1iLnYSfzxMGr8gNDPuOJmkIUZMU766rB00WUfKtudNcxqZmRgBL8BHwe6JeE95B.png?v=1&k=a&s=api&e=1793707200&sig=dn19Z4uKFb-nO0gFe0qr1RFSn0l0hTZvpU3SsfEXHa4) ## Onde acompanhar o uso - A coluna **Último uso** mostra quando cada integração acessou o sistema pela última vez. - Registros criados ou alterados por uma integração aparecem na **Auditoria** com "Integração:" seguido do nome da chave e do início dela, na coluna **Quem fez**. - Recursos adicionais: contratar e cancelar ## Dicas - Crie uma chave para cada integração. Assim, se precisar cortar o acesso de um parceiro, você revoga só a chave dele. - Escolha só as unidades de que a integração precisa. - Se a chave vazar ou se perder, revogue e crie outra. ## Perguntas frequentes - **Perdi a chave. Consigo vê-la de novo?** Não. A chave completa só aparece na criação. Revogue a antiga e crie outra. - **A integração pede a unidade.** Quando a chave acessa mais de uma unidade e o profissional atende em mais de uma delas, a integração precisa informar a unidade em cada chamada. Caso contrário, recebe a mensagem "Informe a unidade: o profissional atende em mais de uma da chave." Avise o responsável pela integração. ## Artigos relacionados - Preferências do sistema - Agendamento online - Auditoria