Custom API Files
Esta API se utiliza para la administración de archivos. Con ella, puedes guardar un archivo en un disco, hacer que un archivo almacenado en un dispositivo esté disponible para que una app lo use, y seleccionar un archivo para que se codifique en base64 o en formato hexadecimal y guardar el resultado en un registro configurado para este fin.
Nota
Es posible que la integración descrita en este artículo no esté implementada en tu ambiente ni esté habilitada para todos tus clientes. Contacta a tu administrador de sistema para recibir ayuda.
Ficha técnica
API ID | 561 |
Código de la API | Custom (FILES) |
Versión de la Call API | 3 |
Versión de la app | lib_files |
Objetivo | Administración de archivos |
Clasificación | Administración de archivos |
Disponible para | iOS, Android |
Usa la integración Custom API Files en Studio
Las siguientes funciones están disponibles para que las uses en tus procesos legacy y también puedes usarlas como bloques en los procesos lambda. Haz clic en cada función para obtener más detalles.
Guarda un archivo en un disco; como entrada, establece la URL donde puedes encontrar el archivo, o bien, la string en formato hexadecimal o el formato de base64 del archivo. | |
Permite que un archivo guardado en el dispositivo esté disponible para que sea usado por una app que el sistema operativo considere adecuada. | |
Selecciona un archivo para que se codifique y guarde en un registro configurado para tal fin. |
Save File Data to Disk
Esta función se usa para guardar un archivo en un disco; como entrada, establece la URL donde puedes encontrar el archivo, o bien, la string en formato hexadecimal o el formato de base64 del archivo.
Configuración del parámetro
Esta función requiere que completes los valores del registro de entrada con el tipo de formato de búfer, el nombre del archivo que se creará y la información del archivo que se guardará.
ID de la función
Registro | Valor |
|---|---|
110 | 1 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
390 | Tipo de formato de búfer | X | HEX_TYPE, BASE64_TYPE, URL_TYPE |
391 | Nombre del archivo que se creará. | X | STRING |
392 | Información del archivo que se guardará en el disco. | X | STRING |
Registros de salida
Registro | Descripción | Valor | ||||||
|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
| ||||||
290 | Nombre del archivo | STRING | ||||||
291 | Extensión del archivo | STRING | ||||||
292 | Ubicación del archivo | STRING |
Open Stored File
Esta función se usa para hacer que un archivo guardado en el dispositivo esté disponible para ser usado por una app que el sistema operativo considere adecuada.
Configuración del parámetro
Esta función requiere que completes el valor del registro de entrada con la ruta a la ubicación del archivo en el dispositivo.
ID de la función
Registro | Valor |
|---|---|
110 | 2 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
300 | Ruta a la ubicación del archivo en el dispositivo (por ejemplo: /root/sdcard/Pictures). | X | STRING |
Registros de salida
Registro | Descripción | Valor | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
|
Save File Data to Register
Esta función se usa para seleccionar un archivo con el selector de archivos del SO del dispositivo a fin de codificarlo en formato base64 o hexadecimal y guardarlo en un registro que se ha configurado previamente para tal fin.
Configuración del parámetro
Esta función no requiere la configuración de ningún parámetro.
ID de la función
Registro | Valor |
|---|---|
110 | 3 |
Registros de entrada
Registro | Descripción | Obligatorio | Valor |
|---|---|---|---|
390 | Codification Type. Tipo de codificación a utilizar con el archivo. | X | HEX_TYPE, BASE64_TYPE |
391 | Register Target. Número del registro donde se almacenarán los datos codificados del archivo. | X | Record number. Los registros entre 800 000 y 819 999 quedan excluidos debido a que se usan para otros fines. |
392 | File picker timeout. Valor numérico que representa los segundos que el selector de archivos estará activo. Transcurrido ese tiempo, el selector se cierra automáticamente y vuelve a la app mostrando un código de error. El valor por defecto es de 30 segundos. | N/A | INT |
Registros de salida
Registro | Descripción | Valor | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
112 | Resultado de la Call |
|