Saltar al contenido principal
Quién lo usa: Los usuarios fundadores generan la clave de API y administran los webhooks, y los desarrolladores usan la clave para crear integraciones personalizadas. Disponibilidad: Todas las regiones; el equipo de soporte de FieldPulse activa Developer Platform (plataforma para desarrolladores) en su cuenta.
La API de FieldPulse es una interfaz para desarrolladores que permite que sus otras aplicaciones de negocio lean y escriban datos de FieldPulse y activen acciones entre herramientas. Úsela para enviar datos de FieldPulse a otra aplicación, o para que una acción en una aplicación cree o actualice registros en FieldPulse. La referencia completa está en la documentación de la API de FieldPulse en Postman (en inglés), y usted genera su propia clave de API desde Company Settings (configuración de la compañía) una vez que se active Developer Platform en su cuenta. Para solicitar la activación, comuníquese con el equipo de soporte de FieldPulse.

Descripción general

La API de FieldPulse es una interfaz de programación de aplicaciones: una forma para que distintas aplicaciones de software se comuniquen y compartan información entre sí. Es útil cuando desea mostrar datos de FieldPulse dentro de otra aplicación, o cuando quiere que una acción en una aplicación active una respuesta en otra. Algunos ejemplos de lo que los equipos de trabajo crean con la API:
  • CRM: crear y actualizar clientes de FieldPulse en un CRM de terceros.
  • Seguimiento de tareas: crear y actualizar subtareas en registros de trabajos desde una herramienta de gestión de tareas de terceros.
  • Comunicación interna: sincronizar los comentarios de trabajos y de registros de clientes desde herramientas como Slack o Microsoft Teams.
  • Captación de prospectos: enviar a FieldPulse los datos de prospectos (nombre, correo electrónico, dirección) captados en su sitio web.
  • Gestión de prospectos: administrar las etapas del embudo de ventas de los clientes desde aplicaciones de marketing y ventas.
  • Programación: crear y asignar trabajos a técnicos de campo desde una aplicación de terceros.
  • Estimados y facturas: enviar estimados y facturas, obtener sus enlaces dinámicos, actualizar la configuración de vista previa y sincronizar facturas con software de contabilidad. Incluye marcar los estimados como convertidos una vez aceptados.
  • Listas de materiales, campos personalizados y contratos: crear listas de materiales, enviar datos de campos personalizados, y redactar y enviar contratos desde una herramienta de terceros a FieldPulse.

Cómo funciona

La API de FieldPulse expone los registros de FieldPulse, tales como clientes, trabajos, estimados y facturas, en forma de endpoints a los que usted llama por HTTP. La lista completa de endpoints, las acciones que admite cada uno y los detalles de la solicitud y la respuesta de cada uno están en la referencia de la API (en inglés) de este Centro de ayuda. Para comenzar, consulte Primeros pasos (en inglés), donde encontrará la URL base, la autenticación, los métodos HTTP y los códigos de estado. Luego, explore los endpoints en la referencia de la API (en inglés). Límite de solicitudes: La API aplica un límite de 50 solicitudes por segundo. Si lo supera, las solicitudes devolverán una respuesta 429 (Too Many Requests) con un encabezado RateLimit-Reset que le indica cuándo se restablece el límite. Las cuentas también tienen un límite mensual de 600,000 solicitudes; al alcanzarlo, las solicitudes devolverán un 429. Webhooks: Los webhooks envían los eventos de FieldPulse a sus propios sistemas en el momento en que ocurren. Puede crearlos y administrarlos usted mismo en Company Settings. Consulte Webhooks más abajo y la referencia de webhooks (en inglés) para ver los nombres de los eventos y sus payloads. FieldPulse notifica a todos los usuarios de la API antes de realizar cualquier cambio que rompa la compatibilidad.

Cómo obtener acceso

El equipo de soporte de FieldPulse activa Developer Platform en cada cuenta, y solo el usuario fundador puede usar esta plataforma.
  1. Consulte la documentación de la API de FieldPulse (en inglés) para encontrar los endpoints de los datos que desea ver, crear o editar.
  2. Como usuario fundador, solicite al equipo de soporte de FieldPulse acceso a la API y describa cómo planea usarla.
  3. El equipo de soporte de FieldPulse revisará su solicitud y activará Developer Platform en su cuenta.
  4. Una vez que el equipo de soporte de FieldPulse la active, abra Company Settings. Aparecerá una pestaña Developer Platform como la última pestaña.
Los administradores, los gerentes de equipo y los agentes de servicio no ven la pestaña Developer Platform. Solo el usuario fundador puede ver o cambiar la clave de API, los webhooks y los Delivery Logs (registros de entrega).
Company Settings con la pestaña Developer Platform resaltada como la última pestaña y la subpestaña API Key con el botón Generate API Key

Su clave de API

Cada cuenta tiene una sola clave de API. Envíela en el encabezado x-api-key de cada solicitud a la API.

Genere su clave

  1. Vaya a Company Settings > Developer Platform > API Key (clave de API).
  2. Seleccione Generate API Key (generar clave de API).
  3. Seleccione Copy (copiar) y guarde la clave en un lugar seguro, como un administrador de contraseñas.
  4. Seleccione Done (listo).
La clave completa se muestra solo una vez. Después de seleccionar Done, solo aparecerán los últimos cuatro caracteres. Si pierde la clave, regenérela.
Después de generar una clave, la subpestaña API Key mostrará la clave enmascarada, la fecha en que se creó, cuándo se usó por última vez y su estado. La subpestaña API Key con una clave enmascarada que termina en cuatro dígitos y el estado Active, las fechas Created y Last used, y los botones Delete key y Regenerate

Regenere su clave

Regenere su clave si la pierde o si cree que quedó expuesta.
  1. En la subpestaña API Key, seleccione Regenerate (regenerar).
  2. Lea la advertencia y seleccione Regenerate para confirmar.
  3. Copie la nueva clave y seleccione Done.
La clave anterior dejará de funcionar inmediatamente y no se podrá restaurar. Actualice de inmediato todas las integraciones que la usen.
Seleccione Delete key (eliminar clave) para eliminar la clave. La subpestaña volverá a su estado inicial y podrá generar una nueva clave en cualquier momento.

Webhooks

Un webhook envía un mensaje a una URL que usted defina cada vez que ocurre un evento seleccionado en FieldPulse, para que sus otros sistemas se mantengan actualizados sin tener que consultar la API para buscar cambios.

Eventos que puede enviar

Cree un webhook

  1. Vaya a Company Settings > Developer Platform > Webhooks.
  2. Seleccione Create New (crear).
  3. Ingrese un Name (nombre) que describa lo que hace el webhook.
  4. Ingrese la Endpoint URL (URL del endpoint) que debe recibir los eventos.
  5. Seleccione un tipo de registro en el menú desplegable Entity (entidad).
  6. Seleccione los Events (eventos) que desea enviar. Las opciones dependerán de la entidad que haya seleccionado.
  7. Deje encendido el interruptor Active (activo) para comenzar a enviar de inmediato, o apáguelo para guardar el webhook sin enviar nada.
  8. Seleccione Create Webhook (crear webhook).
La ventana emergente Create Webhook con los campos Name y Endpoint URL, el interruptor Active, el menú desplegable Entity, la lista de casillas Events y el botón Create Webhook Puede crear todos los webhooks que necesite. Una misma URL de endpoint puede usarse en varios webhooks, y un mismo evento puede enviarse a varios endpoints.
En los eventos Status Update (actualización de estado) de trabajos, estimados y facturas, también seleccionará qué flujo de estados personalizado desea supervisar. Los webhooks se disparan con los cambios en el flujo, no con cada cambio de estado dentro de él.

Requisitos del endpoint

Administre sus webhooks

La lista de webhooks muestra el nombre, la URL del endpoint, el estado y la entrega más reciente de cada webhook. La lista de la subpestaña Webhooks con el interruptor Active, el nombre, la URL del endpoint y los disparadores de un webhook, y los botones Test, Edit y Delete
El equipo de soporte de FieldPulse puede recuperar un webhook eliminado durante 30 días. Después de ese plazo, se eliminará de forma permanente.

Registros de entrega

Los Delivery Logs muestran cada mensaje que FieldPulse ha enviado a sus webhooks, para que pueda confirmar que los eventos están llegando y diagnosticar los que no llegan.
  1. Vaya a Company Settings > Developer Platform > Delivery Logs.
  2. Filtre por Webhook, por Result (resultado), con las opciones All results, Success o Failed, y por Time range (rango de tiempo), con las opciones Last 24 hours, Last 7 days o Last 30 days.
Cada fila muestra la hora, el nombre del webhook, el evento, la respuesta que devolvió su endpoint y si la entrega tuvo éxito. Si su endpoint no responde correctamente, FieldPulse volverá a intentar la entrega. Una entrega se marcará como Failed (fallido) después de tres intentos sin éxito.

Artículos relacionados