Démarrage rapide

Ce guide vous mène de zéro à un vrai e-mail envoyé depuis votre propre domaine.

1. Créer une clé API

   Ouvrez le tableau de bord, allez dans Clés API et cliquez sur Créer une clé API. Choisissez full_access pendant que vous expérimentez. Copiez la clé tout de suite : elle commence par sp_live_ et n’est affichée qu’une seule fois.

   export SPACEPOST_API_KEY="sp_live_YOUR_API_KEY"

   Attention

   Gardez les clés côté serveur. Ne les intégrez jamais dans du code navigateur ou mobile. Créez une clé sending_access par service afin de pouvoir en révoquer une sans toucher aux autres.

2. Envoyer un e-mail de test

   Vous pouvez envoyer immédiatement, sans domaine, avec l’expéditeur de test partagé onboarding@test.spacepost.dev. Il ne peut distribuer qu’aux adresses e-mail des membres de votre équipe et aux adresses de test comme delivered@test.spacepost.dev.

   Node.js

   npm install @spacepost/node

   send.ts

   import { SpacePost } from "@spacepost/node";
   
   const spacepost = new SpacePost(process.env.SPACEPOST_API_KEY);
   
   const { data, error } = await spacepost.emails.send({
     from: "Acme <onboarding@test.spacepost.dev>",
     to: ["delivered@test.spacepost.dev"],
     subject: "Hello from SpacePost",
     html: "<strong>It works!</strong>",
   });
   
   if (error) {
     console.error(error); // { statusCode, name, message }
   } else {
     console.log("Sent", data.id);
   }

   cURL

   curl -X POST https://api.spacepost.dev/emails \
     -H "Authorization: Bearer $SPACEPOST_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "from": "Acme <onboarding@test.spacepost.dev>",
       "to": ["delivered@test.spacepost.dev"],
       "subject": "Hello from SpacePost",
       "html": "<strong>It works!</strong>"
     }'

   Python

   import os
   import requests
   
   r = requests.post(
       "https://api.spacepost.dev/emails",
       headers={"Authorization": f"Bearer {os.environ['SPACEPOST_API_KEY']}"},
       json={
           "from": "Acme <onboarding@test.spacepost.dev>",
           "to": ["delivered@test.spacepost.dev"],
           "subject": "Hello from SpacePost",
           "html": "<strong>It works!</strong>",
       },
   )
   print(r.status_code, r.json())

   Go

   package main
   
   import (
     "fmt"
     "io"
     "net/http"
     "os"
     "strings"
   )
   
   func main() {
     body := `{"from":"Acme <onboarding@test.spacepost.dev>","to":["delivered@test.spacepost.dev"],"subject":"Hello from SpacePost","html":"<strong>It works!</strong>"}`
     req, _ := http.NewRequest("POST", "https://api.spacepost.dev/emails", strings.NewReader(body))
     req.Header.Set("Authorization", "Bearer "+os.Getenv("SPACEPOST_API_KEY"))
     req.Header.Set("Content-Type", "application/json")
     res, err := http.DefaultClient.Do(req)
     if err != nil {
       panic(err)
     }
     defer res.Body.Close()
     out, _ := io.ReadAll(res.Body)
     fmt.Println(res.StatusCode, string(out))
   }

   La réponse est { "id": "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10" }. Ouvrez l’e-mail dans le tableau de bord pour voir sa chronologie : sent, puis delivered.

3. Ajouter et vérifier votre domaine

   Pour envoyer à n’importe qui, envoyez depuis un domaine que vous possédez.

   curl -X POST https://api.spacepost.dev/domains \
     -H "Authorization: Bearer $SPACEPOST_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{ "name": "acme.com" }'

   La réponse liste les records DNS à créer : trois CNAME DKIM, plus un enregistrement MX et un enregistrement TXT pour le sous-domaine send (le return path personnalisé). Ajoutez-les chez votre fournisseur DNS (guides pour Cloudflare, Route 53 et d’autres), puis demandez à SpacePost de vérifier :

   curl -X POST https://api.spacepost.dev/domains/$DOMAIN_ID/verify \
     -H "Authorization: Bearer $SPACEPOST_API_KEY"

   Ou laissez la CLI faire le travail et suivez le DNS en direct :

   npx spacepost domains doctor acme.com

   La vérification se termine généralement en quelques minutes. Le status du domaine passe à verified une fois DKIM confirmé.

4. Envoyer depuis votre domaine

   await spacepost.emails.send({
     from: "Acme <hello@acme.com>",
     to: ["you@example.com"],
     subject: "First real email",
     html: "<p>Sent from my own domain.</p>",
   });

Limites d'un nouveau compte

Pendant les 7 premiers jours, un nouveau compte peut envoyer 100 e-mails par jour. Voir Sandbox du compte.

Et ensuite

Démarrages rapides par langageNext.js, Express, Hono, Python, Go, PHP, Ruby, Rust et plus encore.

Configurer les webhooksSachez quand les e-mails sont distribués, rebondissent ou sont ouverts.

Bonnes pratiques de délivrabilitéArrivez dans la boîte de réception, pas dans les spams.