> ## 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.

# BYOK, Bring Your Own Key

> Use seu provedor de e-mail com suas credenciais, mesmo portão de entrada, conta sua na entrega.

## Por que usar

Algumas equipes **já pagam** um provedor de e-mail e não querem dois sistemas de envio na aplicação. **BYOK** liga esse provedor ao workspace: você **continua chamando a API Notifique** (`/v1/...`), e a plataforma decide **quem entrega**, sua conta externa ou fallback interno.

Analogia: você usa o **mesmo portão** do prédio (API Notifique), mas a **carteirinha** da entrega pode ser da sua operadora.

***

## Quando usar

| Situação                                                                     | BYOK faz sentido?                                                       |
| ---------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
| Contrato existente com provedor externo de e-mail (Resend ou Amazon SES)     | **Sim**                                                                 |
| Quer um endpoint único no código e failover automático                       | **Sim**                                                                 |
| Já tem projeto Firebase / chave APNs e quer push mobile nas suas credenciais | **Sim**, veja [Firebase](/byok/firebase) e [APNs](/byok/apns)           |
| Só usa infraestrutura Notifique                                              | Não precisa                                                             |
| E-mail com domínio **só** no provedor externo, sem aprovar na Notifique      | **Não**, veja **[Resend](/byok/resend)** ou **[Amazon SES](/byok/ses)** |

***

## Como funciona na prática

1. Cadastre o provedor externo no workspace (ordem e ativação por canal).
2. No envio, Notifique **tenta primeiro** o caminho externo (suas credenciais).
3. Se falhar → **fallback** para provedores internos (conforme configuração).
4. Telemetria registra `EXTERNAL` vs `INTERNAL`, resposta sanitizada e ID externo.

### Cobrança

* Todo envio enfileirado na Notifique (BYOK ou interno) **consome 1 crédito** de e-mail (ou o preço pré-pago vigente, \~R\$ 0,05).
* Você continua pagando o provedor externo (Resend/SES) pela entrega na **sua** conta.
* Failover interno **não** gera cobrança extra no mesmo envio (o débito já ocorreu no enqueue).

### Segurança

* Credenciais **criptografadas**; após salvar, API **não devolve** segredo em texto claro.
* Atualizar = **rotacionar** (substituir), não “ler de volta”.

<Info>
  Até **duas** integrações externas por canal (limite pode evoluir, confira o produto).
</Info>

***

## Provedores de e-mail

| Provedor       | Credencial                   | Docs                        |
| -------------- | ---------------------------- | --------------------------- |
| **Resend**     | API key (`re_...`)           | **[Resend](/byok/resend)**  |
| **Amazon SES** | Access Key + Secret + região | **[Amazon SES](/byok/ses)** |

## Provedores de push

| Provedor           | Credencial                           | Docs                           |
| ------------------ | ------------------------------------ | ------------------------------ |
| **Firebase (FCM)** | Service account JSON                 | **[Firebase](/byok/firebase)** |
| **APNs**           | Key ID + Team ID + Bundle ID + `.p8` | **[APNs](/byok/apns)**         |

***

## Próximos passos

* **[Resend (e-mail)](/byok/resend)**
* **[Amazon SES (e-mail)](/byok/ses)**
* **[Firebase (push)](/byok/firebase)**
* **[APNs (push)](/byok/apns)**
* **[E-mail, introdução](/emails-api/como-funciona/index)**
* **[Push, introdução](/push-api/como-funciona/introducao)**
* **[SMS, introdução](/sms-api/como-funciona/index)**