API REST v1

Documentación de la API Propulxia

Integre el poder de Propulxia directamente en su CRM, herramientas internas o aplicaciones. Cree propuestas, gestione clientes potenciales y reciba actualizaciones en tiempo real a través de nuestros webhooks.

Introducción

La API de Propulxia es de tipo REST, basada en respuestas en formato JSON y protegida mediante clave API.

  • URL base : https://app.propulxia.com/api/v1
  • Formato : JSON (Content-Type: application/json)
  • Autenticación : Clé API
  • Disponibilidad : Forfait Entreprise (pro)

1. Autenticación

Todas las solicitudes a la API requieren una clave API transmitida en el encabezado de solicitud HTTP Authorization:

Authorization: Bearer plx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Obtener una clave API

Las claves se generan desde su panel de control en Configuración → Acceso API. Puede nombrar varias claves para diferentes entornos o revocarlas en cualquier momento. La clave solo se muestra una vez durante la creación: guárdela de forma segura.

2. Convenciones

  • Los identificadores (id) son cadenas de caracteres opacas.
  • Los importes se expresan en la unidad monetaria corriente (por ejemplo, 1500.00 para $1500.00).
  • Las fechas (createdAt, etc.) son marcas de tiempo Unix en milisegundos.
  • Cualquier error devuelve un cuerpo con el formato {"error": "message"} con el código HTTP correspondiente.

3. Propuestas

GET/proposals

Lista las propuestas de su cuenta.

curl https://app.propulxia.com/api/v1/proposals?status=sent&limit=10 \
  -H "Authorization: Bearer plx_live_..."
{
  "proposals": [
    {
      "id": "abc123",
      "title": "Refonte site web — Acme inc.",
      "status": "sent",
      "clientId": "cl_789",
      "companyId": "co_456",
      "totalAmount": 4500,
      "currency": "CAD",
      "shareUrl": "https://app.propulxia.com/share/a1b2c3...",
      "createdAt": 1737331200000
    }
  ]
}
POST/proposals

Crea una nueva propuesta.

curl -X POST https://app.propulxia.com/api/v1/proposals \
  -H "Authorization: Bearer plx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Refonte site web",
    "clientId": "cl_789",
    "companyId": "co_456",
    "totalAmount": 4500,
    "currency": "CAD"
  }'
POST/proposals/:id/send

Envía la propuesta por correo electrónico y cambia su estado a sent.

curl -X POST https://app.propulxia.com/api/v1/proposals/abc123/send \
  -H "Authorization: Bearer plx_live_..." \
  -H "Content-Type: application/json" \
  -d '{"to": "client@example.com"}'

4. Clientes

Gestione sus clientes comerciales (contactos dentro de sus empresas objetivo) a través de estos puntos de enlace:

MétodoRutaDescripción
GET/clientsLista todos los clientes.
GET/clients/:idDetalles de un client.
POST/clientsCreación de un prospecto (firstName, lastName, email).
PATCH/clients/:idActualización parcial de la información del cliente.
DELETE/clients/:idEliminación de un cliente.

5. Tareas

Gestione las tareas de seguimiento y recordatorios asociadas a sus propuestas y prospectos:

MétodoRutaDescripción
GET/tasksLista todas las tareas.
GET/tasks/:idObtener los detalles de una tarea.
POST/tasksCrear una tarea (title, dueDate requeridos).
PATCH/tasks/:idModificar una tarea existente.
DELETE/tasks/:idEliminar una tarea.

Exemple de création de tâche :

curl -X POST https://app.propulxia.com/api/v1/tasks \
  -H "Authorization: Bearer plx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Relancer le client Acme",
    "dueDate": 1789958156453,
    "proposalId": "abc123",
    "status": "todo"
  }'

6. Plantillas (Templates)

Recupere en modo de sólo lectura las plantillas estructuradas de propuestas creadas en su cuenta:

MétodoRutaDescripción
GET/templatesLista todas las plantillas.
GET/templates/:idDetalles y secciones de una plantilla.

7. Catálogo de Productos

Sincronice su biblioteca de productos o tarifas con sus herramientas externas:

MétodoRutaDescripción
GET/productsLista los productos.
GET/products/:idDetalles de un producto.
POST/productsCreación de un producto (name, price requeridos).
PATCH/products/:idActualización de un producto.
DELETE/products/:idEliminación de un producto.

8. Colaboradores (Equipo)

Gestione las cuentas de los miembros del equipo de su organización:

MétodoRutaDescripción
GET/employeesLista el equipo.
GET/employees/:idDetalles de un colaborador.
POST/employeesAñadir un miembro (firstName, lastName, email requeridos).
PATCH/employees/:idActualizar un miembro.
DELETE/employees/:idEliminar un miembro.

9. Informes

GET/reports/summary

Recupera KPI sobre su rendimiento comercial.

{
  "totalProposals": 42,
  "byStatus": { "backlog": 5, "in_progress": 3, "sent": 10, "won": 20, "lost": 4 },
  "totalValue": 187500,
  "wonValue": 92000,
  "winRate": 0.8333
}

10. Webhooks

Suscriba una URL HTTPS para recibir notificaciones en tiempo real.

Eventos disponibles:

  • proposal.created: Propuesta creada a través de la API.
  • proposal.sent: Propuesta enviada.
  • proposal.paid: Pago de depósito o saldo confirmado.
  • proposal.signed: Propuesta firmada electrónicamente por el cliente.

Suscripción:

curl -X POST https://app.propulxia.com/api/v1/webhooks \
  -H "Authorization: Bearer plx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://votre-service.com/webhooks/propulxia",
    "events": ["proposal.sent", "proposal.paid"]
  }'

11. Integraciones (Zapier)

Conecte Propulxia a más de 6000 aplicaciones mediante Zapier, sin escribir código. La integración oficial se apoya en esta API y sus webhooks.

Disparadores (cuando ocurre algo en Propulxia):

  • proposal.created
  • proposal.sent
  • proposal.signed
  • proposal.paid
  • new_client

Acciones (Zapier actúa en Propulxia):

  • create_proposal
  • create_client
  • send_proposal

Búsqueda:

  • find_client

Conexión

En Zapier, busque «Propulxia» y pegue una clave API generada en Ajustes → Acceso API. Cada Zap actúa solo sobre su cuenta.

12. Códigos de error

CódigoSignificado / Causa
400Solicitud mal formada o faltan campos obligatorios.
401Autenticación ausente o clave API no válida.
403Su plan no incluye el acceso a la API o derechos insuficientes sobre el recurso.
404Recurso no encontrado.

13. Límites

No hay límites estrictos de velocidad en esta versión, sujeto a un uso razonable. La paginación predeterminada limita las listas a 25 resultados (máx. 100).