Creare una chiave API

Con una chiave API un'applicazione invia direttamente tramite l'API REST di 2Mail, senza connessione SMTP, e riceve indietro per ogni messaggio un identificativo con cui seguirne lo stato. Crei una chiave propria per ogni applicazione, così puoi revocarle singolarmente.

Passo 1: creare la chiave

1. Apri nel pannello di 2Mail la sezione delle chiavi API.
2. Crea una nuova chiave e dàlle il nome dell'applicazione che la userà: il nome del tuo e-commerce, del tuo CRM, del tuo programma di fatturazione. Non un nome generico come "produzione" — tra un anno nessuno saprà più a che cosa serviva.
3. Collega la chiave al dominio o ai domini d'invio per cui può inviare.
4. Salva e copia la chiave subito. Per motivi di sicurezza viene mostrata per intero una volta sola; poi vedi solo il nome e gli ultimi caratteri.

Passo 2: conservare la chiave in sicurezza

Metti la chiave nella configurazione segreta della tua applicazione — una variabile d'ambiente o un gestore di segreti — e mai nel codice sorgente, in una e-mail o in un messaggio di chat. Chi ha la chiave può inviare a nome del tuo dominio. Usa una chiave separata per l'ambiente di prova e per quello di produzione, così una prova non tocca mai i tuoi clienti veri.

Passo 3: usare la chiave

La tua applicazione invia la chiave nell'intestazione di autorizzazione di ogni richiesta all'API. La documentazione dell'e-mail API descrive gli endpoint per inviare un messaggio, richiederne lo stato e gestire le liste. Ogni richiesta che invia un messaggio restituisce un identificativo; conservalo insieme al messaggio nel tuo sistema, così potrai collegarci in seguito lo stato e i bounce.

Passo 4: provare

Invia un messaggio a un indirizzo di prova esterno e controllalo nel registro di consegna del pannello. Nella riga del registro compare il nome della chiave con cui è stato inviato — comodo per vedere quale applicazione invia che cosa.

Revocare o sostituire una chiave

Se sospetti che una chiave sia trapelata, o se se ne va lo sviluppatore che la conosceva, crea prima una nuova chiave, mettila nell'applicazione e solo dopo revoca la vecchia. Così l'applicazione non si ferma mai. Una chiave revocata smette di funzionare all'istante; le richieste che la usano compaiono come rifiutate nel registro.

Dove si sbaglia

• Richiesta rifiutata — la chiave è stata copiata male, è revocata, o non è collegata al dominio per cui invii.
• Chiave persa — non può essere mostrata di nuovo; creane una nuova.
• Una chiave per tutto — funziona, finché non devi disattivare una sola applicazione. Dividile.

Se vuoi ricevere nella tua applicazione anche consegne, bounce e aperture, imposta un webhook.

Non ci riesci?

Comunicaci tramite contatto il nome della chiave e l'ora della tua richiesta. Mai la chiave stessa — quella non dobbiamo vederla.