Appearance

Intégration de la Newsletter ​

Vue d’ensemble ​

Le service Newsletter disponible à l’adresse
https://newsletter-opt-in.spektrum.media/
fournit une API centralisée permettant de gérer les inscriptions aux newsletters pour les sites Umbraco.

Le service prend en charge de manière optionnelle la vérification en double opt-in, ce qui permet de choisir entre :

  • Single opt-in : inscription directe
  • Double opt-in : confirmation de l’inscription via un lien envoyé par e-mail

Fournisseurs pris en charge ​

  • Infomaniak
  • Mailchimp
  • Brevo
  • CartGuru

Endpoints de l’API ​

1. Inscription avec configuration complète ​

Endpoint :
POST /api/Newsletter/Infomaniak/DoubleOptIn

À utiliser lorsque vous souhaitez fournir directement l'ensemble des identifiants et paramètres de l'API.

Corps de la requête:

json
{
  "apiKey": "string",
  "apiSecret": "string",
  "isDoubleOptIn": true,
  "firstName": "string",
  "lastName": "string",
  "mail": "string",
  "listId": "string",
  "client": "string",
  "culture": "string",
  "domain": "string",
  "provider": "string"
}

Parameters:

  • apiKey: API key for the provider
  • apiSecret: API secret for the provider
  • isDoubleOptIn: true for double opt-in, false for single opt-in
  • firstName: Subscriber's first name
  • lastName: Subscriber's last name
  • mail: Subscriber's email address
  • listId: Newsletter list ID
  • client: Client identifier
  • culture: Language/culture code
  • domain: Website domain
  • provider: Provider name (infomaniak, mailchimp, brevo, carts-guru)

2. Inscription via la configuration client ​

Endpoint: POST /api/Newsletter/Infomaniak/DoubleOptInByClient

À utiliser lorsque les identifiants API sont déjà configurés pour le client sur le service.

Corps de la requête:

json
{
  "isDoubleOptIn": true,
  "firstName": "string",
  "lastName": "string",
  "mail": "string",
  "listId": "string",
  "domain": "string",
  "client": "string",
  "culture": "string",
  "provider": "string"
}

Paramètres:

  • isDoubleOptIn: true for double opt-in, false for single opt-in
  • firstName: Subscriber's first name
  • lastName: Subscriber's last name
  • mail: Subscriber's email address
  • listId: Newsletter list ID
  • domain: Website domain
  • client: Client identifier
  • culture: Language/culture code
  • provider: Provider name (infomaniak, mailchimp, brevo, carts-guru)

3. Confirmation de l’inscription (Double Opt-In) ​

Endpoint: GET /api/Newsletter/Confirm/{token}

Appelé lorsqu'un utilisateur clique sur le lien de confirmation reçu par e-mail lors d'une inscription en double opt-in.

Paramètres:

  • token (path parameter): Confirmation token sent in the verification email

CORS et sécurité ​

Assurez-vous que le nom de domaine de votre site Umbraco soit autorisé (whitelisté) sur le service Newsletter afin de permettre les requêtes CORS.

Contributors

The avatar of contributor named as Clément Favre Clément Favre

Changelog