Autenticazione
Mailbeam usa chiavi API per autenticare le richieste. Ogni richiesta deve includere una chiave valida nell'intestazione Authorization.
Token Bearer
Includi la tua chiave API come token Bearer in ogni richiesta:
Authorization: Bearer mb_live_xxxxxxxxxxxxxxxxxxxxEsempio con cURL:
curl -X POST https://api.mailbeam.dev/v1/verify \
-H "Authorization: Bearer $MAILBEAM_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com"}'Prefissi delle chiavi
Le chiavi API di Mailbeam portano un prefisso che indica il loro ambiente:
| Prefisso | Ambiente | Uso |
|---|---|---|
mb_live_ | Produzione | Verifiche reali, contano per la quota |
mb_test_ | Prova | Restituisce sempre risultati prevedibili, non conta |
Usa chiavi mb_test_ in sviluppo e in CI. Le chiavi di prova restituiscono risposte fisse a seconda del dominio dell'email:
@valid.mailbeam-test.dev→ restituisce sempre{ valid: true, score: 99 }@invalid.mailbeam-test.dev→ restituisce sempre{ valid: false, score: 0 }@disposable.mailbeam-test.dev→ restituisce sempre{ valid: false, disposable: true }
Variabili d'ambiente
Non scrivere mai le chiavi API direttamente nel tuo codice. Usa variabili d'ambiente:
# .env.local
MAILBEAM_KEY=mb_live_xxxxxxxxxxxxxxxxxxxxconst headers = {
Authorization: `Bearer ${process.env.MAILBEAM_KEY}`,
"Content-Type": "application/json",
};Rotazione delle chiavi
Conviene ruotare le chiavi API periodicamente, e subito se una viene compromessa:
- Vai alla pagina delle chiavi API del tuo pannello
- Premi Create key per generare una nuova chiave
- Aggiorna la tua applicazione con la nuova chiave
- Premi Revoke sulla vecchia chiave quando il traffico è già passato
Revocare una chiave la invalida all'istante. Le richieste che la usano restituiranno 401 Unauthorized.
Più chiavi
Puoi creare fino a 10 chiavi API per account. Il nostro consiglio:
- Una chiave per ambiente (sviluppo, staging, produzione)
- Una chiave per applicazione se hai più servizi
- Ruota le chiavi quando qualcuno lascia la squadra
Risposte di errore
| Stato | Errore | Descrizione |
|---|---|---|
401 | invalid_api_key | La chiave API manca o è malformata |
401 | revoked_api_key | La chiave API è stata revocata |
403 | insufficient_permissions | La chiave non ha il permesso per questo endpoint |