Probar una consulta sin salir de Pitflo

Antes de pedirle nada a quien te integra, haces tú mismo la consulta y ves la respuesta tal cual: los mismos datos, con los mismos nombres, que va a recibir su sistema.

Antes de empezar#

• Necesitas el permiso de «Integraciones» con alcance de «Toda la empresa» (de fábrica, el Superadministrador y el Administrador) y el plan Empresarial.
• Ten a la mano la llave de la API. Es la que se enseñó una sola vez al crearla o al rotarla; aquí se pega. Si acabas de crear esta API, no tienes que pegar nada: la pestaña la trae puesta.
• La llave que pegues vive solo mientras la pestaña esté abierta. Recargar la borra.

Pasos#

1. En el menú, en el grupo «Control», entra a «Integraciones» y abre tu API. En la lista también puedes abrir la flecha junto a «Abrir» y elegir «Probar esta API», que entra directo a esta pestaña.
2. Cambia el conmutador de la barra de «Configuración» a «Probar». El primer bloque es «Consultar esta API».
3. Pega la llave en «La llave de esta API». Con «Ver token» la ves mientras la revisas y con «Ocultar token» la escondes otra vez; «Olvidar token» la borra en el acto. Si escribes algo que no empieza con pfk_, la pantalla te lo dice: «Un token de /v1 empieza con pfk_ (el pfw_ es del webhook).»
4. En «Recurso», elige cuál vas a consultar. Aquí solo salen los que esta API expone, y salen con su nombre técnico —services, service_payments—, que es el que va en la dirección. Si tu API expone uno solo, no hay nada que elegir.
5. En «Operación», deja «Listar» para traer una página de registros, o elige «Obtener por id» para traer uno solo. Debajo aparecen los parámetros de esa operación, cada uno con su ayuda: limit (de 1 a 100; sin él, 50), updated_since (solo lo que cambió desde esa fecha), workshop (una sucursal) y cursor (la página siguiente). Según el recurso salen además los de relación —service, customer, vehicle…— para traer solo lo que cuelga de una orden, un cliente o un vehículo.
6. Debajo, la petición ya armada. Elige con qué lenguaje quieres verla —«curl», «JavaScript» o «Python»— y pulsa «Enviar».
7. Lee la respuesta. Arriba dice «HTTP 200» y abajo viene el JSON completo, con «Copiar la respuesta» para pegárselo a quien te integra.

Resultado#

Ves los datos de tu taller exactamente como los va a recibir tu sistema, y tienes en el portapapeles la petición que hace falta para pedirlos. La pantalla lo dice con todas sus letras: «Lo que responda aquí es exactamente lo que responderá tu servidor.»

Preguntas frecuentes#

Al pie de la respuesta dice cursor: null. ¿Falló algo? No. La pantalla lo aclara ahí mismo: «cursor: null = última página. No es un error: significa que ya no queda nada por traer.» Cuando el cursor trae un valor, se pasa tal cual en la siguiente petición para seguir paginando.

¿Puedo pegar la petición en un chat con mi proveedor? Sí, y para eso está hecha. «Copiar la petición» copia el ejemplo con un marcador en lugar de tu llave: «lo que copies se puede pegar en un chat sin regalar tu llave.»

Me contestó 403 y dice que el recurso no está habilitado. Es configuración de tu propia API: ese recurso no está marcado. Vuelve a «Configuración», pulsa «Editar campos», márcalo y regresa. Ver Elegir qué expone tu API y cambiarlo después.

Me contestó 429. Pasaste el tope de consultas por minuto de esa llave. La pantalla te dice cuántos segundos esperar. Ver Cuántas conexiones y consultas puedes tener.

Perdí la llave y no la puedo pegar. No se puede volver a ver: en Pitflo solo vive su huella. Rótala desde el panel «Token» de la ficha y guarda la nueva.

¿Desde aquí se puede escribir algo en Pitflo? No. Las únicas dos operaciones que existen son «Listar» y «Obtener por id»: esta API solo consulta.

¿Es seguro pegar aquí mi llave de producción? La pantalla lo advierte: la llave no se guarda en el navegador ni viaja a ningún servidor de Pitflo distinto del API, pero «quien vea tu pantalla la ve». Si estás enseñando el escritorio, usa una llave de prueba.