API para servicios de email marketing

Esta API fue desarrollada para integrarse con servicios de email externos. Permite gestionar listas de correo y contactos a través de un único endpoint (por ejemplo, https://yourserver.com/planfix_integration.php) y acepta solicitudes en formato JSON.

Una vez que haya implementado la integración, puede ponerse en contacto con nuestro Support Service para añadir su servicio a la lista de integraciones disponibles para los usuarios en la interfaz de Planfix.

Conexión con Planfix

• Ir a la sección Administración de la cuenta — Integraciones — Marketing por correo electrónico para conectar y configurar la integración.
• En la sección abierta, seleccione Planfix API al final de la lista.
• Se abrirá una ventana para los ajustes de la integración.
• Debe especificar la dirección a la que Planfix enviará las solicitudes y el API Key para la autorización.

Formato de la solicitud

La solicitud se envía mediante el método POST en formato JSON a la dirección especificada en los ajustes de la integración.

Ejemplo de solicitud:

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

Parámetros de la solicitud:

Nombre	Descripción	Tipo/Formato de datos	Nota
action	La acción a ejecutar	string
authToken	Token de autorización para el acceso a la API	string
data	Datos según la acción	object

Acciones soportadas

• createList — crear una lista de correo
• deleteList — eliminar una lista de correo
• importContacts — importar contactos a una lista
• updateContact — actualizar contacto

createList — Crear una lista de correo

Descripción: Crea una nueva lista de correo con el nombre especificado.

Solicitud:

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

'Respuesta (éxito):

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

Respuesta (error):

{
  "error": "Descripción del error"
}

deleteList — Eliminar una lista de correo

Descripción: Elimina una lista de correo por su identificador.

Solicitud:

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

Respuesta (éxito):

{
  "success": true
}

Respuesta (error):

{
  "error": "Descripción del error"
}

importContacts — Importar contactos a una lista

Descripción: Importa contactos a la lista de correo especificada.

Solicitud:

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

Respuesta (éxito):

{
  "success": true
}

Respuesta (error):

{
  "error": "Descripción del error"
}

updateContact — Actualizar contacto

Descripción: Actualiza un contacto en la lista de correo. Soporta acciones: add, update, delete.

Solicitud:

{
  "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
  }
}

Respuesta (éxito):

{
  "success": true
}

Respuesta (error):

{
  "error": "Descripción del error"
}

Importante

• Todas las solicitudes deben devolver una respuesta en formato JSON.
• En caso de error, siempre debe estar presente el campo "error" con la descripción del error.
• En caso de éxito, siempre debe estar presente el campo "success": true.
• La autorización se realiza mediante el campo "authToken" en cada solicitud.
• Todos los campos de texto deben estar codificados en UTF-8.

Ir a

• API