¿Qué es un API CALL?
Un “API call” (llamada a API, por sus siglas en inglés) es una solicitud realizada por un programa o aplicación a una interfaz de programación de aplicaciones (API) para obtener acceso a un servicio o recurso específico.
Cuando un programa necesita acceder a la funcionalidad o los datos proporcionados por una API, realiza una llamada a esa API. Esto implica enviar una solicitud con parámetros específicos a través de un protocolo de comunicación (como HTTP) al servidor de la API.
Un API call puede ser una solicitud para leer, escribir, modificar o eliminar información, según las capacidades y los permisos proporcionados por la API en cuestión. El resultado de la llamada a la API puede ser una respuesta que contiene los datos solicitados o información sobre el estado de la operación realizada.
¿Cuando se genera un PULL?
Cada vez que se requiera iniciar una extracción de Datos de la fuente/origen de información. Puede ser por una petición del usuario final que introduce sus credenciales para ejecutar una sincronización, o en caso de que la credencial exista (y este autorizada) desde un llamado a un endpoint.
PULL de usuario y PULL programado
-
Pull del usuario .- Pull iniciado por el usuario ingresando sus credenciales al widget o al servicio disponible (bajo demanda).
-
Pull programado .- Pull iniciado programáticamente por Syncfy, esto sucede una vez al día a menos que el cliente decida dar de baja este servicio automático.
¿Cómo se genera un PULL?
Existen cuatro endpoints que inician una extracción de datos:
-
POST a
/v1/credentials/pullsen este endpoint se tienen que proporcionar las credenciales y normalmente se manda llamar desde el usuario final, pero también puede ser de backend a backend. -
POST a
/v1/jobs/pullsen este endpoint se tienen que proporcionar las credenciales y normalmente se manda llamar desde el usuario final, pero también puede ser de backend a backend. A diferencia de también /v1/credentials` este se usa para obtener información que no tiene estructura de cuentas y transacciones, como por ejemplo documentos. -
PUT a
/v1/credentials/:id_credential:/pullseste endpoint puede ser usado para dos casos de uso, para actualizar la clave o contraseña, solo se tiene que introducir una clave nueva (esto es para cuando la credencial ya no es valida en el origen y hay que actualizar la clave) o para ejecutar la credencial, el Pull se ejecuta con las credenciales previamente almacenadas.
NOTA: También se puede usar el POST a
/v1/credentials/pullspara actualizar la clave pero hay que proporcionar también el usuario.
¿Cuándo se cuenta un pull?
- Se cuenta un “pull” cada vez que se realiza una ejecución para descargar información de la fuente, incluyendo, pero no limitado, a transacciones bancarias y documentos, a lo que denominamos pull exitoso.
- Un pull exitoso es aquel que descarga exitosamente la información desde la fuente o que no termina en error de conexión atribuible a la fuente o a Syncfy.
- Un pull fallido significa que la extracción de la información no fue exitosa debido a errores en la fuente o debido a errores atribuibles a Syncfy, según lo determine Syncfy.
- Los errores atribuibles al usuario final (errores 400’s), como el error 401, se considera pull exitoso y se contabilizan para consumo.
- Un pull incluye la descarga de hasta 3,000 transacciones (banking), 500 facturas (fiscal) o 1 documento (fiscal). Si hay más de 3,000 transacciones, 500 facturas o 1 documento, se contará un pull adicional hasta que se extraiga/complete el número total de facturas, documentos o transacciones.
- Por defecto, un pull descarga toda la información disponible (visible) en el sistema de origen.
