Référence de l’API publique

Référence de l’API publiqueLes trois points d’entrée de la collecte embarquable, tels qu’ils répondent aujourd’hui. Ils vivent hors du préfixe /v1 : ce sont des surfaces machine, appelées depuis vos pages ou depuis votre serveur.

Base : https://messagerie.inovertix.com/api/inocampagne/public

Format d’erreur : { "statusCode", "name", "message" } — identique dans tous les modules de CONTROL.

Pour le pas-à-pas d’installation, voir Le formulaire d’inscription en 5 minutes.La clé est une clé de MARQUEContrairement à INOTRACK et INODESK où la clé désigne un site, ici elle désigne une marque — c’est la marque qui porte le consentement, et une même personne peut être inscrite chez l’une et pas chez l’autre.

Clé	Forme	Où elle vit
Publique	`INOCMP_PUB_…`	Dans la page
Secrète	`INOCMP_SEC_…`	Sur votre serveur, jamais dans le navigateur

Emplacement	Exemple
`Authorization`	`Authorization: Bearer INOCMP_SEC_votre_cle_secrete`
En-tête dédié	`X-Inocampagne-Key: INOCMP_PUB_votre_cle_publique`
Paramètre d’URL	`?k=INOCMP_PUB_votre_cle_publique` — clé publique uniquement

Le contrôle d’origine se fait par marque : le domaine appelant doit figurer dans CONTROL → INOCAMPAGNE → Collecte.GET /pingLe test d’installation. Ne renvoie que le nom de la marque : de quoi confirmer qu’on a branché la bonne clé, rien de plus.

bash

curl -sS "https://messagerie.inovertix.com/api/inocampagne/public/ping?k=INOCMP_PUB_votre_cle_publique"

json

{ "ok": true, "brand": "Ma marque", "double_opt_in": true }

Débit : 120 requêtes/min par marque.GET /configL’habillage du formulaire embarqué : nom, logo, couleur, libellés, mention de consentement, réglages de la popup. Rien de sensible — tout est déjà visible sur votre site.

json

{
  "brand": { "name": "…", "slug": "…", "logo_url": "…", "primary_color": "#2563eb", "double_opt_in": true },
  "form": {
    "title": "Recevez nos nouveautés",
    "first_name_label": "Prénom",
    "email_label": "Adresse email",
    "submit_label": "Je m’inscris",
    "consent_notice": "En vous inscrivant, vous acceptez de recevoir les emails de …",
    "success": "Merci ! Vérifiez votre boîte mail : un lien de confirmation vient de vous être envoyé.",
    "honeypot": "inocampagne_website"
  },
  "popup": { "enabled": false, "scroll_percent": 60, "frequency_days": 30, "title": "…", "message": "…" }
}

Attention

La mention de consentement est servie, pas laissée à votre discrétion. C’est elle qui rend l’opt-in défendable. Affichez consent_notice tel quel : réécrit, il finit toujours par être raccourci.

Débit : 120 requêtes/min par marque.POST /subscribeL’inscription. C’est la seule route qui écrit dans la base de profils.

Champ	Obligatoire	Description
`email`	oui	Adresse, 190 caractères maximum
`first_name`	non	Prénom, 80 caractères maximum
`phone`	non	Téléphone, 32 caractères maximum
`source_url`	non	La page d’où vient l’inscription, 500 caractères maximum

bash

curl -sS -X POST "https://messagerie.inovertix.com/api/inocampagne/public/subscribe?k=INOCMP_PUB_votre_cle_publique" \
  -H "Content-Type: application/json" \
  -d '{"email":"awa@exemple.com","first_name":"Awa","source_url":"https://exemple.com/blog"}'

Réponse 202 :

json

{
  "accepted": true,
  "double_opt_in": true,
  "message": "Merci ! Vérifiez votre boîte mail : un lien de confirmation vient de vous être envoyé."
}

Trois règles qui gouvernent les réponses

Attention

202 systématique. Une inscription répond exactement pareil que l’adresse soit déjà connue, inconnue, désinscrite ou supprimée. Sans cela, votre formulaire devient un oracle : « cette personne est-elle cliente de cette marque ? ».

Attention

On n’accuse jamais un visiteur de spam. Une soumission suspecte — champ piège rempli, formulaire envoyé en une demi-seconde — reçoit 202 et n’est simplement pas enregistrée. Un robot qui reçoit une erreur recommence en changeant un paramètre ; un robot qui reçoit 202 croit avoir réussi et s’en va. Et un faux positif sur un vrai visiteur ne lui affiche pas une accusation.

Attention

Le double opt-in est décidé par la marque, pas par l’appelant. Vous ne pouvez pas demander à contourner la confirmation : c’est un réglage de CONTROL.

Seul un email absent ou syntaxiquement invalide produit un 422 : c’est une information sur la saisie du visiteur, pas sur notre base.Débit : 20 requêtes/min par marque et par IP. La double portée est volontaire : borner la marque seule laisserait un robot unique inonder toute sa base ; borner l’IP seule pénaliserait un site derrière un NAT partagé.Codes d’erreur d’authentification

Code	`name`	Ce que ça veut dire
`401`	`missing_api_key`	Aucune clé transmise
`401`	`malformed_api_key`	La valeur n’a pas la forme d’une clé INOCAMPAGNE
`401`	`wrong_module_key`	C’est une clé d’un autre module de CONTROL
`401`	`invalid_api_key`	Clé inconnue
`401`	`revoked_api_key`	Clé révoquée — le message indique la date
`401`	`secret_key_in_url`	Clé secrète passée en `?k=`
`403`	`site_inactive`	La marque est désactivée dans CONTROL
`403`	`secret_key_required`	Route réservée à la clé secrète
`403`	`origin_not_allowed`	Domaine non déclaré pour cette marque
`429`	`rate_limit_exceeded`	Débit dépassé