API pública de Flokzu (Open API)
Puedes encontrar la documentación de la API en https://flokzu.docs.apiary.io
La Open APi te permite interactuar con Flokzu desde sistemas externos, permitiendo la integración con tu propio stack tecnológico.
Get process instance: Permite obtener los datos de una instancia existente. Recibe como parámetro el identificador de la instancia y devuelve un JSON con los datos de la misma, incluido el contenido de los campos y los metadatos. Más información
New process instace: Permite crear una instancia. En los parámetros deberás indicar el proceso y el contenido de los campos a completar. Por defecto, el iniciador del proceso de las nuevas instancias será el usuario System, pero podrás modificarlo agregando nuevas cabeceras a la llamada. Más información
Update process instace: Esta operación te permite modificar los datos de una instancia previamente creada. Es útil cuando necesitas actualizar información a partir de un sistema externo. Más información.
Get record: Este endpoint recupera el primer registro que coincide con una condición especificada. Más información
Add record: Sirve para agregar un nuevo registro a una base de datos específica. Es ideal para añadir datos desde sistemas externos o automatizar la entrada de información en Flokzu. Más información
Update record: Se utiliza para actualizar un registro existente utilizando su ID. Solo se modifican las columnas incluidas en la solicitud. Si la propiedad 'withinsert' está establecido en true, se insertará un nuevo registro si no se encuentra el que se va a actualizar. Más información
List records: Este endpoint recupera una lista de registros que cumplen con una condición especificada. Más información
Send new user invitation: Envía una invitación para crear una nueva cuenta. El usuario recibirá un correo electrónico con el link de confirmación y deberá ingresar sus datos. Más información
Delete user account: Elimina una cuenta de usuario de tu tenant. Más información
Add user role: Agregar rol a usuario. Tanto el rol como el usuario deben estar creados previamente. Más información
Remove user role: Eliminar rol a un usuario especificado. Más información
Get user roles: Listar los roles de un usuario. Más información
Eco (Echo): Devuelve el mismo dato que se le pasa como parámetro.
Operaciones (Operations): sum, concat, contains.
Ten en cuenta que la mayoría de las operaciones provistas en la API están disponibles solamente para planes de pago.
Los límites en la cantidad de peticiones son restricciones que Flokzu impone sobre el número de veces que la OpenAPI puede ser llamada desde una misma dirección IP dentro de un periodo de tiempo especificado.
Estos límites son una práctica común para APIs para ayudar a proteger contra el abuso o mal uso de la API y garantizan que todo el mundo tenga un acceso justo a la API evitando que una persona u organización haga un número excesivo de peticiones que pudiese saturar la API para todos los demás.
Puede enviar hasta 100 solicitudes por minuto. Si supera este límite, será bloqueado durante 1 minuto y se lanzará un código de error 429.
Lamentablemente, no es posible aumentar este límite.
¿Qué se puede hacer con la API pública de Flokzu?
La Open APi te permite interactuar con Flokzu desde sistemas externos, permitiendo la integración con tu propio stack tecnológico.
Operaciones disponibles
Instancias y procesos
Get process instance: Permite obtener los datos de una instancia existente. Recibe como parámetro el identificador de la instancia y devuelve un JSON con los datos de la misma, incluido el contenido de los campos y los metadatos. Más información
New process instace: Permite crear una instancia. En los parámetros deberás indicar el proceso y el contenido de los campos a completar. Por defecto, el iniciador del proceso de las nuevas instancias será el usuario System, pero podrás modificarlo agregando nuevas cabeceras a la llamada. Más información
Update process instace: Esta operación te permite modificar los datos de una instancia previamente creada. Es útil cuando necesitas actualizar información a partir de un sistema externo. Más información.
Bases de datos
Get record: Este endpoint recupera el primer registro que coincide con una condición especificada. Más información
Add record: Sirve para agregar un nuevo registro a una base de datos específica. Es ideal para añadir datos desde sistemas externos o automatizar la entrada de información en Flokzu. Más información
Update record: Se utiliza para actualizar un registro existente utilizando su ID. Solo se modifican las columnas incluidas en la solicitud. Si la propiedad 'withinsert' está establecido en true, se insertará un nuevo registro si no se encuentra el que se va a actualizar. Más información
List records: Este endpoint recupera una lista de registros que cumplen con una condición especificada. Más información
Gestión de usuarios
Send new user invitation: Envía una invitación para crear una nueva cuenta. El usuario recibirá un correo electrónico con el link de confirmación y deberá ingresar sus datos. Más información
Delete user account: Elimina una cuenta de usuario de tu tenant. Más información
Add user role: Agregar rol a usuario. Tanto el rol como el usuario deben estar creados previamente. Más información
Remove user role: Eliminar rol a un usuario especificado. Más información
Get user roles: Listar los roles de un usuario. Más información
Misc
Eco (Echo): Devuelve el mismo dato que se le pasa como parámetro.
Operaciones (Operations): sum, concat, contains.
Ten en cuenta que la mayoría de las operaciones provistas en la API están disponibles solamente para planes de pago.
Límite de peticiones
Los límites en la cantidad de peticiones son restricciones que Flokzu impone sobre el número de veces que la OpenAPI puede ser llamada desde una misma dirección IP dentro de un periodo de tiempo especificado.
Estos límites son una práctica común para APIs para ayudar a proteger contra el abuso o mal uso de la API y garantizan que todo el mundo tenga un acceso justo a la API evitando que una persona u organización haga un número excesivo de peticiones que pudiese saturar la API para todos los demás.
Límite de peticiones de OpenAPI
Puede enviar hasta 100 solicitudes por minuto. Si supera este límite, será bloqueado durante 1 minuto y se lanzará un código de error 429.
¿Es posible aumentar este límite?
Lamentablemente, no es posible aumentar este límite.
Actualizado el: 17/03/2025
¡Gracias!