API pour les services de marketing par e‑mail

Cette API a été développée pour s'intégrer aux services d'emailing externes. Elle permet de gérer les listes de diffusion et les contacts via un point de terminaison unique (par ex. https://yourserver.com/planfix_integration.php) et accepte les requêtes au format JSON.

Une fois l'intégration implémentée, vous pouvez contacter notre Support Service pour ajouter votre service à la liste des intégrations disponibles aux utilisateurs dans l'interface Planfix.

Connexion à Planfix

• Aller à la section Gestion du compte — Intégrations — Email marketing pour connecter et configurer l'intégration.
• Dans la section ouverte, sélectionnez Planfix API à la fin de la liste.
• Une fenêtre de paramètres de l'intégration s'ouvrira.
• Vous devez préciser l'adresse vers laquelle Planfix doit envoyer les requêtes et l'API Key pour l'autorisation.

Format de la requête

La requête est envoyée via la méthode POST au format JSON vers l'adresse spécifiée dans les paramètres de l'intégration.

Exemple de requête :

{
  "action": "action",
  "authToken": "your_authorization_token",
  "data": {
    // Data depending on the action
  }
}

Paramètres de la requête :

Nom	Description	Type/Format de données	Remarque
action	L'action à effectuer	string
authToken	Jeton d'autorisation pour l'accès à l'API	string
data	Données dépendant de l'action	object

Actions prises en charge

• createList — créer une liste de diffusion
• deleteList — supprimer une liste de diffusion
• importContacts — importer des contacts dans une liste
• updateContact — mettre à jour un contact

createList — Créer une liste de diffusion

Description : Crée une nouvelle liste de diffusion avec le nom spécifié.

Requête :

{
  "action": "createList",
  "authToken": "your_authorization_token",
  "data": {
    "listName": "List name"
  }
}

'Réponse (succès) :

{
  "success": true,
  "listId": "unique_list_identifier""
}

Réponse (erreur) :

{
  "error": "Error description"
}

deleteList — Supprimer une liste de diffusion

Description : Supprime une liste de diffusion par son identifiant.

Requête :

{
  "action": "deleteList",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier"
  }
}

Réponse (succès) :

{
  "success": true
}

Réponse (erreur) :

{
  "error": "Error description"
}

importContacts — Importer des contacts dans une liste

Description : Importe des contacts dans la liste de diffusion spécifiée.

Requête :

{
  "action": "importContacts",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "contacts": [
      {
        "id": 123,
        "email": "email@example.com",
        "firstName": "Name",
        "lastName": "Last name"
      }
    ]
  }
}

Réponse (succès) :

{
  "success": true
}

Réponse (erreur) :

{
  "error": "Error description"
}

updateContact — Mettre à jour un contact

Description : Met à jour un contact dans la liste de diffusion. Prend en charge les actions : add, update, delete.

Requête :

{
  "action": "updateContact",
  "authToken": "your_authorization_token",
  "data": {
    "listId": "list_identifier",
    "action": "add|update|delete",
    "contact": {
      "id": 123,
      "email": "email@example.com",
      "firstName": "First name",
      "lastName": "Last name"
    },
    "oldEmail": "old_email@example.com" // only for action=update
  }
}

Réponse (succès) :

{
  "success": true
}

Réponse (erreur) :

{
  "error": "Error description"
}

Important

• Toutes les requêtes doivent retourner une réponse au format JSON.
• En cas d'erreur, le champ "error" avec une description de l'erreur doit toujours être présent.
• En cas de succès, le champ "success": true doit toujours être présent.
• L'autorisation se fait via le champ "authToken" dans chaque requête.
• Tous les champs texte doivent être encodés en UTF-8.

Aller à

• API