> ## Knowledge Base Index
> Fetch the complete knowledge base index at: https://academy.zrupay.com/sitemap.xml
> Use this file to discover available pages before exploring further.
> Pure-Markdown content can be obtained by appending a '.md' suffix to the content URLs listed in the sitemap (without the trailing slash).

# Chave pública e Chave secreta

# O que é a Chave pública e a Chave secreta?

Para se conectar à nossa API, deve inserir a Chave pública e a Chave secreta no plugin ou no seu código.

Deve fazê-lo para cada ambiente de teste ou produção que pretenda utilizar.

Para saber mais sobre a integração com a nossa API, consulte este [guia](https://academy.zrupay.com/pt/article/integracao-via-api-1vczt13/), ou se preferir utilizar um plugin, consulte este [guia](https://academy.zrupay.com/pt/article/integracao-via-plugin-uv1ief/).

> ✋ É muito importante manter estas chaves em segurança e não as colar em locais inseguros.

# Como encontrar as tuas Chaves API?

Para cada ambiente pode encontrar as chaves no seu painel Zru.

> 🧐 Lembre-se que as chaves são diferentes para cada ambiente.

Siga estes passos:

- No painel, certifique-se de estar no **ambiente** desejado.
- No menu lateral esquerdo, selecione **«Configuração»**.
- Clique no mosaico **«Integração»**.
- No bloco **Chaves API** verá uma ficha por cada chave, com o seu nome, o seu estado, a **Chave pública**, a **Chave secreta**, a **Data de criação** e a **Última utilização**.
- Clique no ícone de cópia da chave pública ou da chave secreta para a colar no seu código ou plugin.

> 🧐 Por motivos de segurança, a Chave secreta não pode ser visualizada no painel, mas pode copiá-la e colá-la onde precisar.

> 🧐 Se uma chave ainda não foi utilizada, em **Última utilização** verá **Nunca**.

# Ter várias Chaves API no mesmo ambiente

Pode ter **várias Chaves API** no mesmo ambiente, em vez de um único par de chaves. Assim pode atribuir uma chave a cada aplicação ou integração e identificar num relance com o que está a ser utilizada cada uma.

A **Chave predefinida** do ambiente aparece como uma ficha adicional, mas não pode ser editada nem desativada.

> 🧐 As notificações que o Zru envia para os seus webhooks são sempre assinadas com a **Chave predefinida** do ambiente. Tenha isto em conta se validar a assinatura no seu servidor.

# Criar uma Chave API

- Vá a **Configuração** ▶︎ **Integração**.
- No bloco **Chaves API**, clique em **Criar chaves**.
- Em **Nome da chave**, escreva um nome descritivo que identifique a sua finalidade ou a aplicação com a qual vai ser utilizada.
- Ative **Somente leitura** se quiser que os pedidos assinados com essa chave apenas possam consultar informação, nunca criar nem modificar.
- Em **Estado da chave**, deixe a chave ativa ou crie-a desativada.
- Clique em **Criar chave**.

> ⚠️ **Somente leitura** é decidido ao criar a chave e não pode ser alterado depois. Se necessitar de outra configuração, crie uma chave nova.

# Editar ou desativar uma Chave API

No menu **...** de cada ficha tem duas ações:

- **Editar**: altere o **Nome da chave** ou o seu **Estado**, e clique em **Guardar alterações**.
- **Desativar**: a chave deixa de aceitar pedidos de imediato.

> ⚠️ Ao desativar uma chave, as integrações que a utilizem começarão a falhar até que ative outra chave ou reative esta. Verifique-o antes de a desativar.