> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Chaves de API

> Aprenda como funcionam as chaves de API e como usá-las para acessar a Notifique.

<Tip>
  A chave de API é o **cartão de acesso** do seu sistema na Notifique. Sem ele na requisição, a porta nem abre.
</Tip>

## O que é uma chave de API?

É a credencial que identifica **quem** está chamando a API e **de qual workspace**. Pense no cartão do prédio: você não precisa digitar login e senha em toda requisição, só apresentar o cartão no header.

Cada chave começa com `sk_live_...` (produção) ou `sk_test_...` (sandbox).

## Para que serve?

A chave conecta seu código à Notifique. Com ela você pode:

* **Enviar** mensagens (WhatsApp, SMS, e-mail, push e outros canais)
* **Consultar** histórico, status e mensagens recebidas
* **Gerenciar** instâncias, templates, contatos e automações (conforme os escopos marcados)

Tudo isso sem sessão de usuário no painel. O servidor do seu app fala direto com a API.

## Por que usar chaves separadas?

| Situação                         | O que fazer                                  |
| -------------------------------- | -------------------------------------------- |
| App de produção + app de testes  | Uma chave para cada um                       |
| Dois sistemas no mesmo workspace | Uma chave por integração                     |
| Vazou uma chave                  | Revogue só ela, as outras seguem funcionando |

É como ter um cartão para cada funcionário: se um perder o dele, você cancela só aquele.

## O que você pode fazer no painel

No **Developer → API Keys**, você gerencia os cartões do workspace:

* **Ver** quais integrações já têm chave ativa
* **Criar** uma chave nova com nome e permissões
* **Revogar** uma chave comprometida sem derrubar as outras
* **Rotacionar** acesso: uma chave por app, serviço ou ambiente

Cada chave pertence a um workspace (a **pasta** do seu cliente) e define o que aquela integração pode fazer.

## Sandbox x Produção

É o mesmo prédio, portas diferentes:

* **Sandbox** (`sk_test_...`): **simulador de voo**. Você testa o trajeto inteiro, mas ninguém recebe nada de verdade. Veja os envios em **Developer → Caixa sandbox**
* **Produção** (`sk_live_...`): **voo real**. A mensagem sai e o crédito é debitado

[Saiba mais sobre o sandbox →](/guides/sandbox/index)

## Como criar uma chave

Chaves nascem no painel. Não dá para criar pela API pública:

1. Abra **Developer → API Keys**
2. Clique em **Criar chave**
3. Dê um nome e marque os [escopos](#escopos-e-permissões): as portas que essa chave pode abrir
4. Copie na hora. Começa com `sk_live_...` ou `sk_test_...`

<Warning>
  A chave completa aparece **só uma vez**, como a senha de um cartão novo. Perdeu? Crie outra. Não dá para recuperar.
</Warning>

## Como usar na integração

Em toda chamada à API, apresente o cartão no header `Authorization`:

```http theme={null}
Authorization: Bearer sk_live_xxxxx
```

Também aceitamos `x-api-key` no lugar de `Authorization`. O passo a passo completo está em [Comece aqui](/guides/introducao/comece-aqui).

## Boas práticas

1. **Nunca** deixe a chave no código público. Guarde em `.env`, como a senha do Wi-Fi do escritório
2. **Uma chave por integração**. Se o app de testes vazar, o de produção continua seguro
3. **Vazou?** Revogue em **Developer → API Keys** e emita outra na hora

Mais detalhes: [Segurança e Confiabilidade](/guides/conceitos/seguranca-e-confiabilidade).

## Escopos e permissões

Escopos são as **portas** que cada chave abre. Marque só o que sua integração precisa. Não dê acesso ao estoque inteiro se só vai enviar SMS.

Escolha o canal que vai integrar e veja a lista completa de permissões:

<CardGroup cols={2}>
  <Card title="WhatsApp" icon="whatsapp" href="/whatsapp-api/como-funciona/escopos-api-key">
    Enviar, conectar número, grupos
  </Card>

  <Card title="SMS" icon="comment-sms" href="/sms-api/como-funciona/escopos-da-api-key">
    Enviar, consultar, cancelar
  </Card>

  <Card title="Telegram" icon="paper-plane" href="/telegram-api/como-funciona/escopos-api-key">
    Enviar, conectar bot, ler mensagens
  </Card>

  <Card title="Instagram" icon="instagram" href="/instagram-api/como-funciona/escopos-api-key">
    Enviar, responder comentários
  </Card>

  <Card title="E-mail" icon="envelope" href="/emails-api/como-funciona/escopos-da-api-key">
    Enviar, configurar domínio
  </Card>

  <Card title="Push" icon="bell" href="/push-api/como-funciona/escopos-da-api-key">
    Enviar, gerenciar apps
  </Card>

  <Card title="RCS" icon="mobile-screen" href="/rcs-api/como-funciona/escopos-da-api-key">
    Enviar, consultar, cancelar
  </Card>

  <Card title="Voz" icon="phone" href="/voice-api/como-funciona/escopos-da-api-key">
    Ligar, controlar, gravar
  </Card>

  <Card title="Templates" icon="layer-group" href="/template-api/como-funciona/escopos-da-api-key">
    Criar modelos e disparar
  </Card>

  <Card title="Contatos e audiência" icon="address-book" href="/contacts-api/como-funciona/escopos-da-api-key">
    Contatos, tags, campanhas
  </Card>

  <Card title="Automações" icon="diagram-project" href="/automations-api/como-funciona/escopos-da-api-key">
    Fluxos e eventos
  </Card>

  <Card title="Links curtos" icon="link" href="/short-links-api/como-funciona/escopos-api-key">
    Links e conversões
  </Card>

  <Card title="Números virtuais" icon="hashtag" href="/phone-numbers-api/como-funciona/escopos-da-api-key">
    Consultar e configurar
  </Card>

  <Card title="Add-ons de marketing" icon="puzzle-piece" href="/marketing-addons-api/como-funciona/escopos-api-key">
    Formulários e integrações
  </Card>
</CardGroup>

Porta trancada? Veja [Respostas de erro](/guides/conceitos/resposta-de-erros).

***

## Próximos passos

* [Comece aqui](/guides/introducao/comece-aqui): envie sua primeira mensagem
* [Webhooks](/guides/webhooks/index): receba avisos no seu servidor, como notificação push