sc_api_download(profile, settings, file, destination)

Esta macro se utiliza para descargar los archivos almacenados en los servicios de Storage disponibles en Scriptcase, estos son: Google Drive, DropBox y Amazon S3.

En primer lugar, es necesario crear las claves para utilizar estas API, ya sea para su uso con la macro o mediante la interfaz de la herramienta.

Vea a continuación cómo obtener las credenciales para cada uno de ellos.

Consulte la lista de parámetros a continuación.

Parameters Value Description
profile

Ejemplo de cómo se debe informar el parámetro.

'profile' => 'profile_name',

Este parámetro acepta solo el nombre del perfil creado.

Haga clic aquí, para ver cómo crear un perfil.

Debemos informar el nombre del perfil que se está creando en la opción APIs del menú Herramientas.

Cuando se utiliza, este parámetro carga la configuración informada cuando se crea el perfil.

Cuando se utiliza, el parámetro de configuración no necesita ser informado.

Para obtener más detalles, consulte Uso de la macro con perfil
settings

Ejemplo de cómo se debe informar el parámetro.

'settings' => [
'app_name' => 'scriptcase',
'gateway' => 'dropbox',
'api_key' => '',
'api_secret' => '',
'access_token' => '',
],

Nota: Para obtener más información sobre el parámetro, consulte la tabla de configuración exclusiva a continuación, para cada una de las API

Recibe una matriz con las credenciales de acceso para la API que se utilizará.

Cuando se utiliza, no es necesario introducir el parámetro de perfil.
file

Ejemplo de cómo se debe informar el parámetro.

'file' => {image_file_name},

Opciones permitidas:

  • {image_file_name}
  • [variable global]
  • 'Ruta de archivo'

Este parámetro recibe la ruta completa hasta que se localiza el archivo.

Cuando se utiliza un campo, debe ser del tipo de archivo de nombre de carga.
destination

Ejemplo de cómo se debe informar el parámetro.

Usando un campo
'parents' => {field_name},

Ingresando una String
'parents' => ‘folder_name’,

Opciones permitidas:

  • {nombre del campo}
  • [variable global]
  • "Nombre de carpeta o ruta de almacenamiento en la nube local"

Directorio donde se almacenará el archivo

Cuando no se le informa, el archivo se almacenará en la raíz del servidor de almacenamiento.

Usando la macro con perfil

El uso de la macro con un perfil, requiere la creación previa de la misma.
Haga clic aquí para ver cómo crear un perfil en cada una de las API de almacenamiento disponibles. 

El perfil, o perfil, contiene los datos para usar la API deseada, por lo tanto, cuando se usa un perfil en la macro, no es necesario usar el parámetro settings.

El parámetro de perfil acepta solo el nombre del perfil creado, para el uso dinámico de la macro, será necesario utilizar los parámetros settings.

Ejemplo de uso de la macro con el perfil.

sc_api_upload([
  'profile' => 'minha_api',
  'file' => {archivo},
  'destination' => 'destino',
]);

Usando la macro con el parámetro de configuración

La matriz con las credenciales de acceso que se deben pasar en el parámetro de configuración varía según la API utilizada. 

Vea a continuación cómo utilizar este parámetro de acuerdo con cada una de las API disponibles. 

Cuando se utiliza el parámetro de configuración en la configuración en la macro, no es necesario informar un perfil.

Uso De La Macro Con La Configuración - API De Google Drive

Primero, debemos tener las credenciales para usar la API de Google Drive en la mano, haga clic aquí para aprender cómo obtenerlas. 

Después de configurar las credenciales, vea a continuación todos los valores de la matriz que deben pasarse en el parámetro de configuración usando la API de Google Drive. 

Todos los valores a continuación son obligatorios cuando se usa el parámetro de configuración 

Índice  Valor  Descripción
app_name

Ejemplo de cómo se debe informar el parámetro. 

'app_name' => 'scriptcase', 

Este índice acepta solo cadenas


Nombre de la aplicación ingresado al crear las credenciales de acceso.
gateway

Ejemplo de cómo se debe informar el parámetro. 

'gateway' => 'google_driver',

Este índice acepta solo cadenas
Nombre de la puerta de enlace para identificar la API utilizada.
json_oauth

Ejemplo de cómo se debe informar el parámetro. 

'json_oauth' => 'JSON', 

Lista de opciones aceptadas: 

  • 'String'
  • {nombre del campo} 
  • $ variable

Recibe el contenido del archivo de autenticación generado por el usuario (JSON). 

Este archivo debe descargarse después de crear las credenciales en el sitio web de Google.
auth_code

Ejemplo de cómo se debe informar el parámetro. 

'auth_code' => '5/4wHt7TBTY4MtvQ',

Lista de opciones aceptadas: 

  • {nombre del campo} 
  • $ variable 

Recibe el código auth_code, generado después de configurar la API siguiendo los pasos descritos en el tutorial 

Cómo generar el auth_code para usar la API del controlador de Google 
token_code

Ejemplo de cómo se debe informar el parámetro. 

'token_code' => '',

Lista de opciones aceptadas: 

  • 'String'
  • {nombre del campo}
  • $ variable
 Es posible generar token_code usando nuestra macro sc_api_gc_get_obj

Ejemplos de uso de la macro con Google Drive, usando el parámetro de configuración 

sc_api_download([
  'settings' => [
    'app_name' => {appname},
    'gateway' => 'google_drive',
    'json_oauth' => {jsonoauth},
    'auth_code' => {authcode},
    'token_code' => {tokencode},
  ],
'file' => {archivo},
'destination' => {destino},
]);

Usar La Macro Con La Configuración - Dropbox

En primer lugar, debemos tener las credenciales para usar la API de Dropbox a la mano, haga clic aquí para saber cómo obtenerlas. 

Después de configurar las credenciales, vea a continuación todos los valores de la matriz que se deben pasar en el parámetro de configuración usando la API de Dropbox. 

Todos los valores a continuación son obligatorios cuando se usa el parámetro de configuración

Índice  Valor  Descripción
app_name

Ejemplo de cómo se debe informar el parámetro. 

'gateway' => 'scriptcase',

Este índice acepta solo cadenas

 Nombre de la aplicación ingresado al crear las credenciales de acceso.
gateway

Ejemplo de cómo se debe informar el parámetro. 

'gateway' => 'google_driver', 

Este índice acepta solo cadenas

 Nombre de la puerta de enlace para identificar la API utilizada. 
api_key

Ejemplo de cómo se debe informar el parámetro. 

'api_key' => {field_name}, 

Lista de opciones aceptadas: 

  • 'String' 
  • {nombre del campo} 
  • $ variable
 Reciba el api_key, disponible al configurar la API.
api_secret

Ejemplo de cómo se debe informar el parámetro. 

'api_secret’  => {field_name},

Lista de opciones aceptadas: 

  • 'String' 
  • {nombre del campo} 
  • $variable
 Recibe api_secret, disponible al configurar las credenciales de la API.  

Ejemplos de uso de la macro con Dropbox, usando el parámetro de configuración 

sc_api_download([
  'settings' => [
    'gateway' => 'dropbox',
    'api_key' => {apikey},
    'api_secret' => {apisecret},
    'access_token' => {accesstoken},
  ],
'file' => {archivo},
'destination' => {destino},
]);

Uso De La Macro Con Configuraciones - Amazon S3 

Debemos tener las credenciales para usar la API de almacenamiento de Amazon S3 a mano, haga clic aquí para aprender cómo obtenerlas. 

Después de configurar las credenciales, consulte a continuación todos los valores de la matriz que se deben pasar en el parámetro de configuración mediante la API de Amazon S3. 

Todos los valores a continuación son obligatorios cuando se usa el parámetro de configuración.

Indice  Valor  Descripción 
app_name

Ejemplo de cómo se debe informar el parámetro. 

'app_name' => 'scriptcase',

Este índice acepta solo cadenas
Nombre de la aplicación ingresado al crear las credenciales de acceso. 
gateway

Ejemplo de cómo se debe informar el parámetro. 

'gateway' => 'google_driver', 

Este índice acepta solo cadenas
Nombre de la puerta de enlace para identificar la API utilizada.
api_key

Ejemplo de cómo se debe informar el parámetro. 

'api_key' => {field_name},

Lista de opciones aceptadas: 

  • 'String' 
  • {nombre del campo} 
  • $ variable
Reciba el api_key, disponible al configurar la API.
api_secret

Ejemplo de cómo se debe informar el parámetro. 

'api_secret' => {field_name},

Lista de opciones aceptadas: 

  • 'String' 
  • {nombre del campo} 
  • $ variable 

Recibe api_secret, disponible al configurar las credenciales de la API.
region

Ejemplo de cómo se debe informar el parámetro. 

'region' => 'us-east-1',

El parámetro de región de la macro acepta solo el código de región. 

Para que sea más fácil, siga un enlace para verificar el código de cada región. 

https://docs.aws.amazon.com/general/latest/gr/rande.html 

 Recibe el código de región, el mismo utilizado en la creación de credenciales.
bucket

Ejemplo de cómo se debe informar el parámetro. 

'bucket' => 'bucket_name',

Lista de opciones aceptadas: 

  • 'String' 
  • {nombre del campo} 
  • $ variable
 Recibe el nombre del depósito creado al configurar las credenciales de la API. 

  

Ejemplos de uso de la macro con Amazon S3, usando el parámetro de configuración 

sc_api_download([
  'settings' => [
    'app_name' => 'scriptcase',
    'gateway' => 'S3',
    'api_key' => {apikey},
    'api_secret' => {apisecret},
    'region' => {api_region},
    'bucket' => {api_bucket},
  ],
'file' => {archivo},
'destination' => {destino},
]);