Documentación Pay AAM

Introducción a Pay AAM

En este documento encontrará todo lo necesario para implementar micro transacciones en sus proyectos de Aplicaciones, Videojuegos y sitios Web a través del sistema de Pay AAM.

¿Cómo funciona Pay AAM?

Para comprender como implementar las micro transacciones con el sistema de Pay AAM, el primer paso es conocer cómo funciona esta plataforma:

  • El desarrollador se registra en la plataforma e introduce sus datos de comercio de EnZona.
  • El desarrollador registra sus aplicaciones en la plataforma para agregarles los productos o servicios que está ofreciendo en estas.
  • Una vez agregadas las aplicaciones, el desarrollador integra Pay AAM en estas.
  • Una vez las aplicaciones sean publicadas con las compras integradas, los usuarios de las mismas podrán consumir sus servicios de pago.
  • El desarrollador obtendrá en tiempo real los ingresos de sus ventas.

Requisitos

¿Cuales son los requisitos para utilizar Pay AAM?

Para poder utilizar los servicios de Pay AAM para monetizar sus aplicaciones, debe ser trabajador por cuenta propia o artista independiente con un comercio en EnZona. Cómo crear un comercio en EnZona, si no tiene comercio en EnZona, no se preocupe, porque en este documento le mostraremos como crearlo en un par de minutos.

¿Cómo registrarse en Pay AAM?

para registrarse en la plataforma, debe dirigirse a https://pay.aam.cu/register.html y completar el formulario de registro con los datos solicitados.

Este formulario será revisado a mano una vez sea enviado.

Es importante que introduzca un número de teléfono y un correo electrónico válio ya que por medio de estos contactaremos con usted una vez su cuenta sea creada, y a estos le informaremos de cualquier problema que pueda existir con la misma.

Una vez que se registre y reciba nuestro correo informando la correcta activación de su cuenta, puede dirigirse a https://pay.aam.cu/login.html para acceder al formulario de inicio de sesión y entrar al panel de administración.

Primeros pasos en el panel de administración

Al iniciar la sesión por primera vez se topará con este mensaje.

Como puede ver en la alerta, falta poner su información de pago.

¿Cómo introducir la información de pago?

  1. Primero debe dirigirse al enlace que se muestra en la alerta.
  2. Luego debe rellenar el formulario según la información requerida.
  3. Cómo obtener el usuario de EnZona

    • Diríjase a su cuenta de EnZona y entre al apartado de información https://www.enzona.net/personalInfo tras iniciar sesión en la misma y copie lo que aparece al lado de "Usuario".

      Cómo obtener el UUID de la cuenta de comercio de EnZona

    • Primero debe iniciar sesión en su cuenta de EnZona y si ya tiene cuenta de comercio, luego presione en el botón "Ir a cuenta de comercio". Si no tiene una cuenta de comercio, puede crearse una en https://bulevar.enzona.net/wizard/merchant o si lo prefiere puede seguir nuestra guía.
    • Luego en el apartado de COMERCIOS diríjase a la opción de Detalles del comercio.
    • Por último copie el código que aparece aquí.

      Cómo obtener el Base64(consumer-key:consumer-secret) de tu Aplicación de tu comercio

    • Lo primero es dirigirse a la página https://api.enzona.net/ y autenticarse (esta página puede tardar unos minutos en cargar).


    • Aquí debe poner el nombre de usuario que vimos en el primer paso y la contraseña de su cuenta de EnZona

      Ahora diríjase al apartado de aplicaciones

    • Y ahí seleccione la opción que dice "DefaultApplication"

    • Ahora dentro de esta, vamos al apartado de Production Keys y presionamos donde dice mostrar llaves

    • Y por último vamos a la parte donde dice Generando Tokens de Acceso
    • Y copian el código que está despues de "Authorization: Basic"
  4. Si introdujo sus datos correctamente será enviado a la siguiente página donde deberá poner el monto del pago creado.
    • Cómo consultar los pagos creados

    • Vaya a la página principal de su comercio y ahí saldrán los pagos creados y su estado, de ahí copie el monto del último
  5. Luego si todo salió correctamente debería ver el siguiente mensaje:
  • Una vez que reciba este mensaje ya tiene asociada su cuenta de comercio de EnZona con Pay AAM. En este punto ya puede empezar a agregar sus aplicaciones a la plataforma e integrarle los productos.

    Cómo agregar las Aplicaciones y los productos en Pay AAM

    • Nos dirigimos a la pestaña de Aplicaciones del Panel de Administración y presionamos sobre el botón Agregar

    • Una vez añadida la aplicación, ya podemos empezar a agregarle productos a esta.
    • Luego tendremos un formulario como este, donde podremos introducir los datos de nuestro producto.
      1. Nombre del producto.
      2. ID del producto (Este ID debe ser unico para este producto dentro de la App).
      3. La descripción del producto.
      4. Precio del producto en CUP.
      5. Webhook a ejecutarse al realizarse un pago. Esto lo veremos más adelante en el documento.

    • Ahora al volver al listado de productos de nuestra App, podemos ver que ya tenemos el producto añadido.

      Los productos con el precio de $0CUP son tomados como productos de prueba y con estos puede probar el correcto funcionamiento de la integración.

    Ahora sí, vamos a ver cómo integrar Pay AAM en sus aplicaciones

    Una vez que tenemos nuestra App registrada en el sistema y con sus productos añadidos, es el momento de integrar este sistema en esta.

    Integración de Pay AAM con Unity

    Unity es uno de los softwares para el desarrollo de videojuegos más utilizados en el mundo, y Cuba no escapa de este gran motor, si desarrolla sobre este motor, le tenemos un paquete para implementar Pay AAM en este de una manera muy sencilla.

    Pay AAM.unitypackage (Unity 2018 o superior)

    Cómo usar el paquete oficial de Pay AAM para Unity

    1. Lo primero es importar el paquete a Unity 2018+ arrastrándolo hacia la ventana de Project e importando todo el contenido.
    2. Luego buscamos el prefab AAM Payment y lo arrastramos a la Escena.

      El componente lucirá de esta manera:

    3. Ahora tenemos que agregar a este componente el Id de los productos y la función que se debe llamar al ser comprados.

      OJO es importante que el nombre de paquete de la Aplicación coincida con el que puso en la plataforma

    4. Es tiempo de enviar al usuario a hacer la compra.

      Hasta este momento tenemos configurado todo lo necesario para que el paquete de Unity entienda los productos existentes en la Aplicación, ahora vamos a enviar al usuario a comprar estos productos:

      Para enviar al usuario a comprar un producto utilizaremos la función Comprar() del paquete AAM Payment.

      string Producto_ObjId;
      Comprar(Producto_ObjId);


      Tras hacer esto se abrirá el navegador con la página para hacer el Check Out del producto con la información proporcionada en el Panel de Administración:

      • Nombre de la Aplicación
      • Nombre de paquete
      • Nombre del producto
      • Descripción del producto
      • Precio del producto

      Tras realizar el pago, y volver a la Aplicación, esta lo detectará y ejecutará la función que se estableció en el componente AAM Payment para ese producto

      Así estaría todo listo, y ya puede probar sus compras integradas en su proyecto de Unity

    Integrar Pay AAM en cualquier sistema o aplicación

    Para saber como integrar Pay AAM en su aplicación, primero debemos saber como funciona este sistema.

    Lo primero es que debe registrar al cliente (o sea el usuario de la aplicación) en el sistema de Pay AAM y guardar su token en el almacenamiento del dispositivo del mismo. Eso se logra llamando a la siguiente url:

    https://pay.aam.cu/getToken.php?app=cu.tu.aplicacion

    Donde ese "cu.tu.aplicacion" debe sustituirlo por el nombre de paquete de la aplicación. La respuesta será directamente el token correspondiente a ese usuario.

    Ojo es importante que este token quede almacenado, ya que este es el que va a identificar al usuario en el sistema

    Una vez almacenada esta información, debe existir un ciclo o bucle que esté llamando a la dirección:

    https://pay.aam.cu/get-remain.php?cli=[el token guradado del usuario]

    Aquí es donde vamos a revisar si le debemos al usuario alguna recompensa por sus pagos. La respuesta a estas peticiones será un arreglo con el id del producto que falta por recompensar.

    Ejemplo:

    ["premium","noads","coins"]

    Una vez obtenida esta respuesta, Pay AAM dará por recompensados estos pagos. Tenga en cuenta que pueden haber más de un pago hecho al mismo producto, en este caso se devolverá el id del producto repetido cuantas veces el usuario haya pagado por él.

    Ejemplo:

    ["premium","noads","coins","coins"]

    Entonces por cada uno de estos id que devuelva la plataforma, su aplicación debe dar al usuario la recompensa prometida.

    Luego para mandar al usuario a pagar por un producto, debe hacerlo ir a la siguiente dirección en un navegador externo:

    https://pay.aam.cu/pay.php?id=[la id del producto]&cli=[el token del usuario]

    Esto sería todo, ya con esto puede comenzar a integrar ahora mismo.

    Cómo crear una cuenta de comercio en EnZona:

    1. Lo primero es dirigirse a https://bulevar.enzona.net/wizard/merchant e introducir los datos solicitados y aceptar los términos y condiciones.
    2. En el siguiente paso debe introducir los datos del negocio, e introducir sus datos de TCP o artista independiente
    3. En el paso siguiente debe poner los datos de su cuenta bancaria, si el campo "Número de la cuenta" se queda deshabilitado una vez que defina la moneda de la cuenta, solo debe recargar la página y ya debería salir.
    4. Una vez que defina los datos de su cuenta, luego al terminar de poner estos datos y los datos de interés, debe seleccionar consumo de API en los planes.
    5. Al terminar estos pasos, la web le dirá que espere un correo electrónico que debería llegar en 72 horas, pero la espera no será necesaria, pues su cuenta se encuentra activa una vez termine de rellenar el formulario completo así que ya puede comenzar a integrar su comercio con Pay AAM.

    Webhooks en Pay AAM

    Pay AAM le permite a sus usuarios llamar ciertos Webhooks cuando sus clientes realizan pagos en sus aplicaciones.

    Un Webhook es una funcion que se ejecuta de servidor a servidor, en este caso se ejecuta al ser detectado un nuevo pago en su aplicacion.

    Si está utilizando un Webhook, al momento de llamar a la url de pago debe agregarle el parámetro par y debe agregarle en urlencode los parámetros con los que va a terminar la URL que puso en el campo Webhook en su producto. Vamos a ver un ejemplo:

    Supongamos que este es el Hook que le asignamos a nuestro producto:

    https://mihook.cu/hook/

    Pero mi servidor donde tengo este endpoint le pide un parámetro GET que se llama username, ahora tenemos que pasarle este parametro con su valor: username=miusuario, debemos codificarlo en URL_ENCODE quedando: username%3Dmiusuario

    La url modificada debe quedar:

    https://pay.aam.cu/pay.php?id=[la id del producto]&cli=[el token del usuario]&par=username%3Dmiusuario

    Pay AAM le agrega un parámetro GET ProdId con el ID del producto que se ha pagado, haciendo que la llamada al final quede de la siguiente manera:

    https://mihook.cu/hook/?username=miusuario&ProdId=[la id del producto]

    Este caso puede ser usado por ejemplo para recompensar a un usuario por comprar una suscripción, o una característica, o cierta cantidad de una moneda en su sistema.