Documentation

Démarrer en toute sécurité avec Postline

Vérification de domaine, accès API, envoi en sandbox, suppression et événements de livraison.

Ouvrir la référence API

Liste de contrôle avant l'envoi externe

  • La clé API de production est disponible immédiatement.
  • Avant la vérification du domaine, utilisez sandbox@srs-postline.com uniquement pour un membre du projet.
  • Vérifiez le domaine From, publiez DKIM et autorisez le return-path via SPF.
  • Configurez l'alignement DMARC avant l'envoi à des destinataires externes.
  • Traitez les webhooks de bounce et de plainte de manière idempotente et respectez les décisions de suppression.
POST /v1/emails

Requête / Réponse

RequêtecURL
curl --request POST 'https://api.srs-postline.com/v1/emails' \
  --header 'Authorization: Bearer srs_live_...' \
  --header 'Idempotency-Key: order_4821' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "from": "Postline <info@example.com>",
    "to": ["user@example.net"],
    "subject": "Your order is ready",
    "html": "<p>Order #4821 is ready.</p>",
    "text": "Order #4821 is ready."
  }'
Réponse202 Accepted
HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "msg_01JPOSTLINEEXAMPLE",
  "status": "queued",
  "created_at": "2026-08-22T12:00:00Z"
}

Paramètres d’entrée

ParamètreTypeRequisDescriptionExemple
Authorizationheader · stringOuiClé API à portée limitée émise par le tableau de bord sous forme de jeton Bearer.Bearer srs_live_…
Idempotency-Keyheader · stringNonIdentifiant stable pour un envoi logique ; fortement recommandé.order_4821
fromstringOuiNom et adresse de l’expéditeur sur un domaine vérifié.Postline <info@example.com>
tostring[]OuiUne à 100 adresses e-mail de destinataires.["user@example.net"]
subjectstringOuiObjet du message.Votre commande est prête
htmlstringNonCorps HTML. html ou text est obligatoire.<p>…</p>
textstringNonCorps en texte brut. text ou html est obligatoire.Commande #4821…

Codes de réponse

StatutHTTPDescription
202AcceptedLe message est mis en file d’attente ; cela ne signifie pas encore qu’il est livré.
400Bad RequestJSON invalide ou champs non pris en charge.
401UnauthorizedLa clé API est invalide, expirée ou révoquée.
403ForbiddenLe scope manque ou le domaine de l’expéditeur n’est pas vérifié.
422Unprocessable EntityLe destinataire figure dans la liste de suppression.
429Too Many RequestsLa limite de requêtes du projet a été dépassée.
Exemple d’erreur422 Unprocessable Entity
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

Terminologie de l'authentification

Postline signe les messages avec DKIM. SPF est une politique d'autorisation publiée dans le DNS. DMARC évalue l'alignement entre le domaine From visible et une identité SPF ou DKIM authentifiée ; SPF et DMARC ne sont pas appliqués comme des signatures de message.

TLS protège les données en transit entre les sauts pris en charge. Le courrier électronique ordinaire n'est pas chiffré de bout en bout, et le fournisseur du destinataire peut traiter le contenu du message.

Résultats de livraison

Le fait qu'un serveur destinataire accepte un message ne prouve pas son placement en boîte de réception. Considérez accepted, deferred, hard bounce, soft bounce, complaint, suppressed, spam placement et inbox placement comme des résultats distincts.

Modèle d’accès actuel

Les clés actuelles utilisent srs_live_. Avant la vérification du domaine From, l’expéditeur sandbox partagé ne peut écrire qu’aux membres du projet. Ensuite s’appliquent quotas, suppression, limites destinataires et contrôles anti-abus. 202 signifie mis en file, pas livré.

Ressources d’intégration

Utilisez le guide pratique pour humains et agents IA ; OpenAPI fait foi pour les champs.