Início rápido

Este guia leva você do zero até um e-mail real enviado do seu próprio domínio.

1. Crie uma chave de API

   Abra o painel, vá em Chaves de API e clique em Criar chave de API. Escolha full_access enquanto estiver experimentando. Copie a chave na hora: ela começa com sp_live_ e é exibida apenas uma vez.

   export SPACEPOST_API_KEY="sp_live_YOUR_API_KEY"

   Cuidado

   Mantenha as chaves no servidor. Nunca as inclua em código de navegador ou de app móvel. Crie uma chave sending_access por serviço para poder revogar uma sem mexer nas outras.

2. Envie um e-mail de teste

   Você pode enviar imediatamente, sem um domínio, usando o remetente de teste compartilhado onboarding@test.spacepost.dev. Ele só entrega para os endereços de e-mail dos membros da sua equipe e para os endereços de teste, como 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))
   }

   A resposta é { "id": "0192e1c4-7a3b-7c1e-9d2f-3b5a8e6f4c10" }. Abra o e-mail no painel para ver a linha do tempo dele: sent e, depois, delivered.

3. Adicione e verifique seu domínio

   Para enviar a qualquer pessoa, envie de um domínio que você possui.

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

   A resposta lista os records de DNS a criar: três CNAMEs de DKIM, mais um registro MX e um TXT para o subdomínio send (o return path personalizado). Adicione-os no seu provedor de DNS (guias para Cloudflare, Route 53 e outros) e depois peça ao SpacePost para verificar:

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

   Ou deixe a CLI fazer o trabalho e acompanhe o DNS ao vivo:

   npx spacepost domains doctor acme.com

   A verificação costuma ser concluída em poucos minutos. O status do domínio muda para verified assim que o DKIM é confirmado.

4. Envie do seu domínio

   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 de conta nova

Nos primeiros 7 dias, uma conta nova pode enviar 100 e-mails por dia. Veja Sandbox da conta.

Próximos passos

Início rápido por linguagemNext.js, Express, Hono, Python, Go, PHP, Ruby, Rust e mais.

Configure webhooksSaiba quando os e-mails são entregues, rejeitados ou abertos.

Boas práticas de entregabilidadeChegue à caixa de entrada, não à pasta de spam.