Feedback

# API

Conjunto de rutinas y estándares establecidos por un software para la utilización de sus funcionalidades. Para facilitar el uso de API en Scriptcase, se ha creado una interfaz que nos permite configurar y utilizar algunas API con el mínimo de código posible.

## Lista de APIs

Al acceder Herramientas> API, nos encontramos con la lista de las API que ya se han configurado.

## APIs de envío de correo electrónico

El Scriptcase se conecta con tres diferentes API para enviar mensajes de correo electrónico: SMTP, Mandrill y Amazon SES.

### Configuración de SMTP

SMTP es el protocolo estándar para el envío de correos electrónicos a través de Internet, cada proveedor tiene su propio SMTP.

> Para más información acerca de la configuración de SMTP Haga clic aquí

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Modo - Define el nivel de acceso de esta API, que son: Public, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tenían acceso a esta API; Usuario, donde solo el usuario creador de la API tendrá acceso a cualquier proyecto.
- Puerta: Seleccione la forma de envío del correo electrónico. En este caso está seleccionado SMTP. El SMTP es el protocolo estándar para el envío de e-mails a través de Internet, cada proveedor tiene su propio SMTP.
- Servidor SMTP: Dirección del servidor SMTP referente al proveedor que se está utilizando.
- Puerto SMTP: Puerto utilizado por el servidor de correo electrónico. Utilice el puerto 465 para seguridad con SSL, el puerto 587 para seguridad con TLS o el puerto 25 como puerto sin seguridad. Al omitir el valor el Scriptcase asumirá el valor por defecto: 25
- Usuario SMTP: Usuario del servidor SMTP.
- Contraseña SMTP: Contraseña del usuario del servidor SMTP.

- Protocolo SMTP: Define el protocolo de seguridad que se utilizará. Al omitir el valor Scriptcase asumirá el valor predeterminado sin seguridad.

- Desde el email: define el correo electrónico de origen, que enviará los correos electrónicos.
- De nombre: Nombre que se mostrará en el correo electrónico enviado.

### Configuración de Mandrill

El Mandrill es una API de correo electrónico transaccional para usuarios de MailChimp, ideal para enviar correos electrónicos orientados a datos.

- API: Permite selecionar uma API já configurada em Ferramentas > API ou configurar aqui selecionando -personalizadas-. Neste caso serão exibidas algumas opções de acordo com o Gateway selecionado.

- Puerta: Seleccione la forma de envío del correo electrónico. En este caso está el mandril está seleccionado. El Mandrill es una API de correo electrónico transaccional para usuarios de MailChimp, ideal para enviar correos electrónicos orientados por datos.

- Clave API: Ingrese la clave obtenida al configurar su API.

- Desde el email: define el correo electrónico de origen, que enviará los correos electrónicos.
- De nombre: Nombre que se mostrará en el correo electrónico enviado.

> Para más información sobre el mandrill

### Configuración de Amazon SES

Amazon Simple Email Service (Amazon SES) es un servicio de envío de correo electrónico creado para ayudar en el envío de e-mails de marketing, notificaciones y mensajes transaccionales.

- Clave API: Ingrese la clave obtenida al configurar su API.
- API Secret: Informe la secret access key de su conta.

- Región: El Amazon SES posee endpoints en varias regiones, con el fin de reducir la latencia de la red, informe la región del endpoint más cercana a su aplicación. Ver las regiones.

- Desde el email: define el correo electrónico de origen, que enviará los correos electrónicos.
- De nombre: Nombre que se mostrará en el correo electrónico enviado.

> Para más información sobre el Amazon SES

## APIs de envío de SMS

El Scriptcase se conecta con diferentes API para enviar mensajes de texto SMS. Son ellas:

- Twilio
- Plivo
- Clickatell

### Configurando el envío por Twilio

VER VIDEO

Twilio es un conjunto de bibliotecas que permite la comunicación por SMS a escala global. Para la correcta configuración, necesitamos informar los datos de ID de autenticación, Token de autenticación y Número remitente, conforme imagen abajo:

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Puerto: define la API que se utilizará. Debemos seleccionar Twilio.
- ID de Autenticación: Ingrese el ID de autenticación de su cuenta Twilio;
- Token de Autenticación: Informe el Token de autenticación de su cuenta Twilio;
- De: Introduzca el número de remitente para enviar SMS;

### Configurar el envío por Plivo

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Puerto: define la API que se utilizará. Debemos seleccionar Plivo.
- ID de autenticación: introduzca el identificador de autenticación de su cuenta de tarjeta;
- Token de Autenticación: Informe el Token de autenticación de su cuenta Plivo;
- De: Introduzca el número de remitente para enviar SMS;

### Configurar el envío por Clickatell

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Puerto: define la API que se utilizará. Debemos seleccionar Clickatell.
- Token de Autenticación: Introduzca el Token de autenticación de su cuenta Clickatell;

## APIs de pago

Es posible utilizar API para procesar pagos en línea en Scriptcase. Están disponibles integración con las siguientes API:

- paypal
- pagseguro
- Mercado Pago
- Braintree
- Stripe

### Configuración de pago usando Paypal

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Puerto: define la API que se utilizará. Debemos seleccionar paypal_express;
- Usuario: Usuario de autenticación de la cuenta Paypal;
- Contraseña: Contraseña de autenticación de la cuenta de Paypal;
- Firma: Firma de autenticación de la cuenta Paypal;
- Modo de prueba: Permite utilizar la API como modo de prueba.

### Configuración de pago usando Pagseguro

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada.
- Puerto: define la API que se utilizará. Debemos seleccionar pagseguro;
- Ambiente: Especifica el tipo de entorno que se utiliza (sandbox o producción);
- Email de Autenticación: Correo de autenticación de la cuenta de pago;
- Token de Autenticación: Token de autenticación de la cuenta de pago;
- Charset: Charset que se utilizará para intercambiar información con la API;
- Auth AppID: ID de autenticación de la aplicación;
- Auth AppKey: Clave de autenticación de la aplicación.

### Configuración de pago usando Mercado Pago

> Para utilizar una API en un proyecto publicado, es necesario realizar la Configuración de esta API en el entorno de producción, en el menú API.

- Nombre: define el nombre que identificará la API configurada. Recomendamos que se defina el nombre para identificar los datos utilizados en la configuración, ya que es posible crear más de una API con esta puerta de enlace, por lo que será más fácil identificar la API en el momento de la llamada. Mercadopago;

- Name: Nombre dado a la API;
- Modo: Define si la API creada será a nivel Proyecto, Usuario o Público;
- Puerta: El Mercadopago;
- Token de autenticación: token de autenticación de la aplicación.

> Para aprender a crear credenciales de Mercado Pago, sigue este tutorial: [Creando tus credenciales de Mercado Pago][Tutorial Mercadopago]

### Configuración de pago usando Braintree

> Para utilizar una API en un proyecto publicado, es necesario realizar la Configuración de esta API en el entorno de producción, en el menú API.

- Name: Define el nombre que identificará la API configurada.
- Modo: Define el nivel de acceso de esta API, los cuales son: Público, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tendrán acceso a esta API; Usuario, donde solo el usuario creador de la API tendrá acceso en cualquier proyecto. (Aconsejable para esta API a nivel de proyecto).
- Gateway: Define la API que se utilizará. Debemos seleccionar Braintree.
- Id : su ID de comerciante es el identificador único para toda su cuenta de puerta de enlace, incluidas las diversas cuentas de comerciante que pueden estar en su puerta de enlace. A menudo llamado ID público o ID de producción, su ID de comerciante será diferente para sus puertas de enlace de producción y sandbox.
- Publick Key : esta es su identificación pública específica del usuario. Cada usuario asociado con su puerta de enlace Braintree tendrá su propia clave pública.
- Clave privada : esta es su clave privada específica del usuario. Cada usuario asociado con su puerta de enlace Braintree tendrá su propia clave privada. Su clave privada no debe compartirse fuera del uso de una llamada API, incluso con nosotros.
- Modo de prueba : activa o desactiva el modo de prueba de la API.

###### Ejemplo informando el perfil de la API creada en la interfaz como parámetro en la macro

    $gateway = sc_call_api('braintree');

    $response = $gateway->transaction()->sale([
      'amount' => '10.00',
      'paymentMethodNonce' => $nonceFromTheClient,
      'deviceData' => $deviceDataFromTheClient,
      'options' => [
        'submitForSettlement' => True
      ]
    ]);
    echo '<pre>';
    print_r($response);

### Configuración de pago usando Stripe

> Para utilizar una API en un proyecto publicado, es necesario realizar la Configuración de esta API en el entorno de producción, en el menú API.

- Name: Define el nombre que identificará la API configurada.
- Modo: Define el nivel de acceso de esta API, los cuales son: Público, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tendrán acceso a esta API; Usuario, donde solo el usuario creador de la API tendrá acceso en cualquier proyecto. (Aconsejable para esta API a nivel de proyecto).
- Gateway: Define la API que se utilizará. Debemos seleccionar Braintree.
- Clave API : ingrese la clave API.

###### Ejemplo informando el perfil de la API creada en la interfaz como parámetro en la macro

    $gateway = sc_call_api('stripe');

    $gateway->charges->create([
      'amount' => 2000,
      'currency' => 'brl',
      'source' => 'tok_mastercard',
      'description' => 'My First Test Charge with Scriptcase',
    ]);

## APIs de Almacenamiento

El scriptcase proporciona 3 API para este tipo de servicio. Solo funciona en campos de tipo: imagen (nombre de imagen) y documento (nombre de documento).

- Dropbox
- Google Drive
- S3

### Configurar la API de Dropbox

Dropbox es un servicio para almacenar y compartir archivos. Se basa en el concepto de “computación en la nube”. Pertenece a Dropbox Inc., con sede en San Francisco, California, EE. UU. La compañía que desarrolló el programa proporciona centros de cómputo que almacenan los archivos de sus clientes.

- Nombre: Define el nombre que identificará la API configurada. Recomendamos que el nombre se defina de una manera que permita identificar los datos utilizados en la configuración, ya que es posible crear más de una API con este Gateway, de esta forma será más sencillo identificar la API en el momento de la llamada.

- Modo: Define el nivel de acceso de esta API, que son: Público, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tendrán acceso a esta API; Usuario, donde solo el usuario que creó la API tendrá acceso a cualquier proyecto. (Recomendable para esta API el nivel de proyecto).

- Gateway: Define la API que se utilizará. Debemos seleccionar Dropbox.

- Clave API: Ingrese la clave obtenida al configurar su API.

- API secreta: Ingrese la clave de acceso secreta para su cuenta.

- Token de acceso: Ingrese el token de acceso generado en su cuenta de Dropbox.

### Google Drive

Google Drive es un servicio de disco virtual lanzado por Google. El servicio permite el almacenamiento de archivos en la nube de Google.

- Nombre: Define el nombre que identificará la API configurada. Recomendamos que el nombre se defina de una manera que permita identificar los datos utilizados en la configuración, ya que es posible crear más de una API con este Gateway, de esta forma será más sencillo identificar la API en el momento de la llamada.

- Modo: Define el nivel de acceso de esta API, que son: Público, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tendrán acceso a esta API; Usuario, donde solo el usuario que creó la API tendrá acceso a cualquier proyecto. (Recomendable para esta API el nivel de proyecto).

- Gateway: Define la API que se utilizará. Debemos seleccionar Google drive.

- Nombre de la aplicación: Nombre de la aplicación a utilizar.

- Json OAuth: Ingrese el contenido del archivo de autenticación de usuario generado.

- Código de autenticación: Ingrese el código de identificación obtenido al configurar su API.

### Amazon S3

Amazon Simple Storage Service (Amazon S3) es un servicio de almacenamiento de objetos que ofrece escalabilidad, disponibilidad de datos, seguridad y rendimiento líderes en la industria. Esto significa que los clientes de todos los tamaños y sectores pueden usarlo para almacenar cualquier cantidad de datos en una amplia variedad de casos de uso, como sitios web, aplicaciones móviles, copia de seguridad y restauración, archivo, aplicaciones comerciales, dispositivos IoT y análisis de big data.

- Clave API: Ingrese la clave obtenida al configurar su API.

- API Secreta: Ingrese la clave de acceso secreta para su cuenta.

- Región: Amazon SES tiene puntos finales en varias regiones, para reducir la latencia de la red, informe a la región de punto final más cercana a su aplicación.

- Cubeta: Informe al depósito para almacenar archivos en Amazon S3.

## APIs de autenticación

Esta API de autenticación de Google le permite crear sistemas más seguros mediante la autenticación de dos factores.

Para utilizar esta API es necesario instalar la aplicación Google Authenticator en su dispositivo móvil.

- Google Store
- Apple Store

Para la configuración de la API debemos informar:

#### Nombre

Se usa solo para la identificación de API dentro de la herramienta.

#### Modo

Esta opción define la disponibilidad de la API dentro de Scriptcase. Las opciones de configuración son:

- Public: con esta opción, todos los proyectos y usuarios de la herramienta tendrán acceso a esta API para su uso.
- Proyecto: al guardar la API a nivel de proyecto, todos los usuarios del proyecto tendrán acceso a esta API para su uso.
- User: solo el usuario que realizó la configuración de la API tendrá acceso a su uso en cualquier proyecto.

> El recurso solo se puede adoptar en el proyecto donde se creó, independientemente del modo de guardado elegido.

#### Puerta de enlace

Define la API de autenticación que se utilizará.

#### Dominio

Define el dominio habilitado para usar la autenticación de dos factores.

Ejemplos:

- myscriptcase.com.br
- 127.0.0.1

> Debemos informar solo a un dominio para usar la API.

## API Google Sheets

Scriptcase permite usar la API de Google Sheets para la integración con sus proyectos.

### Google Sheets

Google Sheets es un programa de hoja de cálculo incluido como parte de la suite gratuita de Google Doc Editor basada en la web que ofrece Google.

Para aprender a crear y configurar sus credenciales haga clic aquí

> Esta API tiene la funcionalidad de simplemente insertar datos en la hoja de cálculo. No hay posibilidad de borrar o editar registros de la hoja de cálculo.

- Nombre: Define el nombre que identificará la API configurada. Recomendamos que el nombre se defina de una manera que permita identificar los datos utilizados en la configuración, ya que es posible crear más de una API con este Gateway, de esta forma será más sencillo identificar la API en el momento de la llamada.

- Modo: Define el nivel de acceso de esta API, que son: Público, donde todos los usuarios de todos los proyectos tienen acceso a esta API; Proyecto, donde todos los usuarios de este proyecto tendrán acceso a esta API; Usuario, donde solo el usuario que creó la API tendrá acceso a cualquier proyecto. (Recomendable para esta API el nivel de proyecto).

- Gateway: Define la API que se utilizará. Debemos seleccionar Google drive.

- Nombre de la aplicación: Nombre de la aplicación a utilizar.

- Json OAuth: Ingrese el contenido del archivo de autenticación de usuario generado.

- Código de autenticación: Ingrese el código de identificación obtenido al configurar su API.

#####