Paso a explicarte brevemente el funcionamiento de la API externa para que puedas trabajar los experimentos y los recursos de tensiones de venta desde tus aplicaciones cliente.
La ruta base de la API será: "https://ia-pplication.com/apps/v1"
* Todas las solicitudes tienen que incluir la cabecera Authorization de la siguiente manera:
Authorization: Bearer <tu api key aquí>
Este "api key" es el que generas desde la herramienta en la sección y "Apis y herramientas"
Recursos de las tensiones: "/get-assets"
- Solicitud "GET"
- Parámetros:
- app_package_name: El nombre de paquete (Android), o el ID (iOS), que está asociado al registro de aplicación cuando lo creamos desde la herramienta.
- Retorna un listado con todos los recursos asociados a esa aplicación que no estén eliminados en la plataforma.
Sesiones para las los test A/B: "get-experiment-record"
- Solicitud "GET"
- Ej: http://ia-pplication.com/apps/v1/get-experiment-record?uuid_experiment=<tu UUID>
- Parámetros:
- uuid_experiment: El UUID del experimento que hemos registrado en la herramienta.
- Retorna:
- id: El UUID del registro que se acaba de crear (Luego lo utilizaremos para darle valor a dicho registro).
- created_at: La fecha de creación del registro (en segundos).
- record_key: La key (del conjunto de keys que hemos definido al crear el experimento) que utilizaremos para definir que valor mostrar desde nuestra app.
- Errores:
- 403: Si no has enviado ningún API KEY, o la que has enviado no está registrada y asociada a alguna aplicación en la plataforma.
- 404: Si no encuentra el UUID del experimento, si el experimento solicitado no existe, si la APP asociada al experimento no esta en las APPS asociada al API KEY enviada.
- Solicitud "PUT":
- Ej: http://ia-pplication.com/apps/v1/get-experiment-record?uuid_record=<tu UUID>
- Parámetros:
- uuid_record: Será el UUID del registro que hemos creado previamente con el "GET".
- Retorna:
- "1" En caso de que todo haya ido bien.
- "0" En caso de que haya fallado.
- Errores:
- 403: Si no has enviado ningún API KEY, o la que has enviado no está registrada y asociada a alguna aplicación en la plataforma.
- 404: Si no encuentra el UUID del registro, si el registro solicitado no existe, si el experimento asociado al registro no esta en las APPS asociada al API KEY enviada.
Paso a explicar cómo funcionará lo de los test A/B:
- Al llamar al "get-experiment-record", a través del "GET", se creará un registro con valor "false" y obtendremos los detalles del registro para poder trabajar con él, saber lo que debemos mostrar a través de su key, etc...
- Ahora, al llamarlo a través del "PUT", pasaremos del valor "false" a "true" lo que significa que el usuario ha realizado la acción que nosotros queríamos.
Supongamos que queremos hacer un experimento con el color del botón.
- Solicitud "GET". El servicio nos devuelve que pintemos de color azul y asigna "false" a ese registro.
- Ahora, cuando el usuario haya pulsado sobre el botón azul llamamos al "PUT" y actualizamos el valor a "true".
- Si no pulsa sobre él, se tomará cómo negativo y ese registro quedará cómo "false".
Nota: Los registros son dinámicos, por lo que las claves UUID únicas una vez se pierdan en el cliente, desde el servidor no se podrán recuperar y quedarán con el valor que están en ese momento hasta que decidas reinicializar los valores del experimento, o eliminarlo.
Espero que se haya entendido. Si no ha sido así, y te falta algo por comprender, desde dentro de la herramienta tienes una sección de soporte desde la que puedes ponerte en contacto con nosotros.