API Domaines Personnalisés

Configurer et vérifier un domaine de suivi personnalisé pour votre organisation afin d’améliorer la délivrabilité des emails.

Obtenir le Domaine

Récupérer la configuration actuelle du domaine personnalisé.

Endpoint


GET /api/organizations/domain

Exemple de Requête


curl -X GET NEXT_PUBLIC_BASE_URL/api/organizations/domain \
  -H "x-api-key: votre-cle-api"

Schéma de Réponse

Champ	Type	Description
`customDomain`	`string \| null`	Domaine configuré ou null si non défini
`domainVerified`	`boolean`	Si le domaine a été vérifié
`domainVerifiedAt`	`string \| null`	Timestamp ISO 8601 de la vérification
`expectedCNAME`	`string`	Valeur CNAME cible pour la configuration DNS

Exemple de Réponse


{
  "customDomain": "track.example.com",
  "domainVerified": true,
  "domainVerifiedAt": "2024-03-15T12:00:00.000Z",
  "expectedCNAME": "mailpulse-io.lyten.agency"
}

Définir le Domaine

Configurer un domaine de suivi personnalisé pour votre organisation.

Endpoint


POST /api/organizations/domain

Corps de la Requête

Champ	Type	Requis	Description
`domain`	`string`	Oui	Sous-domaine à utiliser pour le suivi (ex : `track.example.com`)

Exemple de Requête


curl -X POST NEXT_PUBLIC_BASE_URL/api/organizations/domain \
  -H "x-api-key: votre-cle-api" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "track.example.com"
  }'

Exemple de Réponse


{
  "customDomain": "track.example.com",
  "domainVerified": false
}

Supprimer le Domaine

Supprimer le domaine de suivi personnalisé de votre organisation.

Endpoint


DELETE /api/organizations/domain

Exemple de Requête


curl -X DELETE NEXT_PUBLIC_BASE_URL/api/organizations/domain \
  -H "x-api-key: votre-cle-api"

Exemple de Réponse


{
  "success": true
}

Vérifier le Domaine

Lancer une vérification DNS pour votre domaine configuré.

Endpoint


POST /api/organizations/domain/verify

Exemple de Requête


curl -X POST NEXT_PUBLIC_BASE_URL/api/organizations/domain/verify \
  -H "x-api-key: votre-cle-api"

Exemple de Réponse (Succès)


{
  "verified": true,
  "domainVerifiedAt": "2024-03-15T12:00:00.000Z"
}

Exemple de Réponse (Échec)


{
  "verified": false,
  "error": "Enregistrement CNAME introuvable"
}

Configuration CNAME

Pour vérifier votre domaine personnalisé, ajoutez un enregistrement CNAME chez votre fournisseur DNS :

Type	Nom	Valeur
`CNAME`	Votre sous-domaine (ex : `track`)	`mailpulse-io.lyten.agency`

La propagation DNS peut prendre jusqu’à 48 heures. Une fois l’enregistrement en place, appelez l’endpoint de vérification pour finaliser la configuration.

Réponses d’Erreur

Statut	Description
`401 Unauthorized`	Clé API invalide ou manquante
`400 Bad Request`	Format de domaine invalide ou domaine déjà utilisé

Exemple d’Erreur


{
  "error": "Format de domaine invalide"
}