🔐 Disponible para todos los planes
🎯 Para los que quieren conectar procesos en Pipefy con otras herramientas.
⏩ Resumen:
Si los procesos de su empresa dependen de otras herramientas además de Pipefy, puede utilizar nuestra API para optimizar su trabajo.
Dado que esta es una funcionalidad low-code, necesita tener un conocimiento mínimo en el tema para utilizarla.
Por lo tanto, si esta es su primera experiencia, le recomendamos que realice nuestro curso básico de APIs e integraciones de Pipefy, que es totalmente gratuito. También tenemos más contenido al respecto en Pipefy Developers y en nuestra Comunidad.
Qué es una API
API es una sigla para Application Programming Interface y funciona como una conexión entre softwares o entre computadoras.
Su objetivo es simplificar la programación y hacerla más segura, mostrando solo la información y acciones necesarias para el desarrollo.
La API de Pipefy se puede utilizar para integraciones con sistemas propios o de terceros, siempre que posean una API pública.
💡 Consejo: Vale la pena mencionar que la API a conectar debe aceptar solicitudes CORS (cross-origin resource sharing), un mecanismo que permite que un sitio web acceda a recursos de otro incluso si están en dominios diferentes. Obtén más información sobre CORS.
Para qué sirve
En general, las APIs evitan el trabajo duplicado. Si utiliza uno o más softwares además de Pipefy en su proceso, puede crear una API para:
Transferir información de una plataforma a otra;
Automatizar actividades, como crear tarjetas, actualizar o eliminar información en masa;
Editar campos en tarjetas;
Crear y editar registros en su database.
GraphQL
GraphQL es un lenguaje de consulta y manipulación de APIs web creado por Facebook. También es el nombre dado al backend que proporciona información en formato GraphQL. Puede utilizarlo junto con otros lenguajes como Node, Ruby y Python.
En GraphQL tenemos queries, que utilizamos para hacer consultas, y mutations, utilizadas para cambiar datos en la API.
🔎 Aquí encontrará una introducción a los endpoints de GraphQL de Pipefy.
🔎 Y aquí una serie de referencias sobre queries, mutations y más.
Accesos
Para usar la API de Pipefy, tiene dos opciones:
IDE pública o GraphQL playground: Utilizada solo para ayudar con los comandos. No es necesario un código de autorización, ya que está sincronizada con la autenticación de usuario en Pipefy. Los cambios y mutations realizados en esta área se reflejarán en su pipe. No es posible crear automatizaciones o robots en la IDE pública.
URL de desarrollo (endpoint): Úsala para hacer solicitudes a nuestra API y crear integraciones personalizadas que se adapten mejor a sus necesidades.
Autenticación
Para la autenticación de Pipefy GraphQL, necesitará un token OAuth2 Bearer. Obtén el suyo siguiendo estos pasos:
Vaya a: https://app.pipefy.com/tokens;
Haga clic en Generar nuevo token;
Proporciona una descripción para el token;
Haga clic en Guardar;
Consulta el token según sea necesario al autenticar en Pipefy.
🔔 Atención: Solo los administradores o superadministradores pueden utilizar la API de Pipefy. Obtén más información sobre funciones y permisos en Pipefy.
Cómo se contabilizan las APIs en su plan
Cada plan de Pipefy contabiliza las APIs de manera diferente:
En el plan Starter, tiene derecho a hasta 20 llamadas de APIs por mes;
En el plan Business, hasta 500 llamadas;
En el plan Enterprise, hasta 10.000 llamadas;
Y en el plan Unlimited, son personalizadas.
Una llamada de API es una solicitud enviada al servidor, para que devuelva una información. Por ejemplo: buscar tarjetas con título X, en el pipe Y.
Límite de solicitudes
El número de consultas subsiguientes permitidas por unidad de tiempo es de 500 solicitudes cada 30 segundos. Si este número se excede, el usuario no podrá hacer una solicitud de API por 5 minutos;
El número de configuraciones de webhooks se basa en el tamaño del proceso y también depende de la suscripción de la organización. Recomendamos no tener más de 30 webhooks para cada pipe, pero esto puede variar;
Las entradas y salidas se basan principalmente en el tamaño de su proceso, utilizando las queries y mutations preconstruidas. En general, cada solicitud devuelve solo 50 registros, por lo que se requiere el uso de paginación;
El límite para el tamaño de los archivos adjuntos es de 512 MB para cada archivo;
Por motivos de seguridad, los enlaces de archivos generados están disponibles solo por 15 minutos.
Contenidos Relacionados
🎓 ¡Aprende a hacer mucho más con los cursos gratuitos de Pipefy Academy!
🌎 ¡Únete a la Comunidad Pipefy para hacer preguntas, compartir sugerencias, estar al día y compartir sus conocimientos con gente de todo el mundo!