Cómo Crear una Funcionalidad de Logros

Esta guía describe el proceso completo para añadir una funcionalidad de logros a tu aplicación web o móvil usando Trophy. A modo ilustrativo, usaremos el ejemplo de una plataforma de estudio que utiliza logros para incentivar y recompensar a los usuarios por ver tarjetas de memoria.

Para ver un ejemplo completamente funcional de esto en la práctica, consulta la demostración en vivo o el repositorio de github.

Requisitos previos

Una cuenta de Trophy
Aproximadamente 10 minutos

Configuración de Trophy

En Trophy, las Métricas son los componentes fundamentales de la gamificación y modelan las diferentes interacciones que los usuarios realizan con tu producto. En esta guía, la interacción que nos interesa es flashcards-viewed, pero puedes crear una métrica que mejor represente la interacción en torno a la cual quieres construir logros. En el panel de Trophy, dirígete a la página de métricas y crea una métrica.

Una vez que hayas creado tu métrica, dirígete a la página de logros y crea los logros que desees. Puedes encontrar todos los detalles sobre los tipos de logros y los diferentes casos de uso en la documentación de logros. Para los propósitos de esta guía, hemos configurado un par de logros basados en un número creciente de tarjetas volteadas:

10 tarjetas de estudio
50 tarjetas de estudio
100 tarjetas de estudio
250 tarjetas de estudio
1,000 tarjetas de estudio

También hemos configurado algunos logros relacionados con Rachas, pero no entraremos en detalle sobre estos en esta guía.

Para una guía completa sobre cómo agregar una función de rachas a tu aplicación web o móvil, consulta nuestra guía completa.

También puedes crear logros de aniversario que se desbloquean cuando los usuarios alcanzan hitos anuales desde su fecha de registro. En Trophy rastreas las interacciones de los usuarios enviando Eventos desde tu código a las API de Trophy contra una métrica específica. Cuando se registran eventos para un usuario específico, cualquier logro vinculado a la métrica especificada se completará automáticamente si se cumplen los requisitos. Esto es lo que hace que construir experiencias gamificadas con Trophy sea tan fácil: hace todo el trabajo por ti entre bastidores.

Instalación del SDK de Trophy

Para interactuar con Trophy desde tu código, utilizarás el SDK de Trophy disponible en los principales lenguajes de programación. Instala el SDK de Trophy:

npm install @trophyso/node

gem install trophy_api_client

pip install trophy

composer require trophyso/php

implementation 'so.trophy:trophy-java:1.0.0'

<dependency>
  <groupId>so.trophy</groupId>
  <artifactId>trophy-java</artifactId>
  <version>1.0.0</version>
</dependency>

go get github.com/trophy-so/trophy-go

// .NET Core CLI
dotnet add package Trophy

// Nuget Package Manager
nuget install Trophy

// Visual Studio
Install-Package Trophy

A continuación, obtén tu clave de API desde la página de integración de Trophy y agrégala como una variable de entorno solo del lado del servidor.

TROPHY_API_KEY='*******'

Asegúrate de no exponer tu clave de API en código del lado del cliente.

Rastreo de Interacciones de Usuarios

Para rastrear un evento (interacción de usuario) contra tu métrica, utiliza la API de cambio de métrica.

curl -X POST https://api.trophy.so/v1/metrics/flashcards-flipped/event \
     -H "X-API-KEY: <apiKey>" \
     -H "Idempotency-Key: flashcard-view-42" \
     -H "Content-Type: application/json" \
     -d '{
  "user": {
    "id": "18",
    "email": "user@example.com",
    "tz": "Europe/London"
  },
  "value": 750
}'

import type { EventResponse } from "@trophyso/node/api";

const response: EventResponse = await trophy.metrics.event(
  "flashcards-flipped",
  {
    user: {
      id: "18",
      email: "user@example.com",
      tz: "Europe/London",
    },
    value: 750,
    idempotencyKey: "flashcard-view-42",
  }
);

client.metrics.event(
    key="flashcards-flipped",
    user=EventRequestUser(
        id="18",
        email="user@example.com",
        tz="Europe/London",
    ),
    value=750.0,
)

$user = new EventRequestUser([
    'id' => '18',
    'email' => 'user@example.com'
]);

$request = new MetricsEventRequest([
    'user' => $user,
    'value' => 750
]);

$trophy->metrics->event("flashcards-flipped", $request);

MetricsEventRequest request = MetricsEventRequest.builder()
      .user(
        EventRequestUser.builder()
          .id("18")
          .email("user@example.com")
          .build()
      )
      .value(750)
      .build();

EventResponse response = client.metrics().event("flashcards-flipped", request);

response, err := client.Metrics.Event(
    "flashcards-flipped",
    &api.MetricsEventRequest{
        User: &api.EventRequestUser{
            Id: "18",
            Email: "user@example.com",
        },
        Value: 750,
    },
)

var user = new EventRequestUser {
   Id = "18",
   Email = "user@example.com"
};

var request = new MetricsEventRequest {
   User = user,
   Value = 750
};

await trophy.Metrics.EventAsync("flashcards-flipped", request);

result = client.metrics.event(
  :key => 'flashcards-flipped',
  :user => {
    :id => '18',
    :email => 'user@example.com'
  },
  :value => 750
)

La respuesta a esta llamada de API es el conjunto completo de cambios en cualquier característica que hayas construido con Trophy, incluyendo cualquier logro que se haya desbloqueado como resultado del evento.

Response

{
  "metricId": "d01dcbcb-d51e-4c12-b054-dc811dcdc623",
  "eventId": "0040fe51-6bce-4b44-b0ad-bddc4e123534",
  "total": 750,
  "achievements": [
    {
      "id": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
      "trigger": "metric",
      "metricId": "5100fe51-6bce-6j44-b0hs-bddc4e123682",
      "metricName": "Flashcards Flipped",
      "metricValue": 500,
      "name": "500 Flashcards Flipped",
      "description": "Write 500 words in the app.",
      "achievedAt": "2020-01-01T00:00:00Z"
    }
  ],
  ...
}

Valida que esto funciona revisando el panel de Trophy.

Visualización de Logros

Tienes varias opciones para mostrar logros en tu aplicación. Aquí veremos las opciones más comunes.

Notificaciones Emergentes

Podemos usar la respuesta de la API de cambio de métrica para mostrar notificaciones emergentes (o ‘toasts’) cuando los usuarios completen logros. Aquí tienes un ejemplo de esto en acción:

Achievement Completed Pop-up

// Sends event to Trophy
const response = await viewFlashcard();

if (!response) {
  return;
}

// Show toasts if the user has unlocked any new achievements
response.achievements.forEach((achievement) => {
  toast({
    title: achievement.name,
    description: achievement.description,
    image: {
      src: achievement.badgeUrl,
      alt: achievement.name,
    },
  });
});

Si deseas reproducir efectos de sonido, utiliza la API de Audio HTML5 y siéntete libre de usar estos archivos de audio que recomendamos.

Mostrar Logros del Usuario

Para obtener todos los logros que un usuario ha completado, utiliza la API de logros de usuario.

curl --request GET \
  --url https://api.trophy.so/v1/users/{id}/achievements \
  --header 'X-API-KEY: <api-key>'

trophy.users.achievements("user-id");

client.users.achievements("user-id")

$trophy->users->achievements("user-id");

UserAchievementsResponse response = client.users().achievements("user-id");

response, err := client.Users.Achievements("user-id")

await trophy.Users.AchievementsAsync("user-id");

result = client.users.achievements(
  :id => 'user-id'
)

También puedes obtener logros incompletos al mismo tiempo pasando includeIncomplete como 'true'.

Mostrar Todos los Logros

Si en cambio deseas mostrar todos los logros que has configurado en Trophy como parte de una interfaz de usuario globalmente accesible que no está vinculada a un usuario en particular, puedes utilizar la API de todos los logros.

curl --request GET \
  --url https://api.trophy.so/v1/achievements \
  --header 'X-API-KEY: <api-key>'

trophy.achievements();

client.achievements()

$trophy->achievements();

UserAchievementsResponse response = client.achievements();

response, err := client.Achievements()

await trophy.AchievementsAsync();

result = client.achievements()

Estadísticas de Completado de Logros

Tanto la API de logros de usuario como la API de todos los logros incluyen estadísticas de completado como completions (el número de usuarios que han completado un logro) y rarity (el porcentaje de usuarios que han completado un logro).

Análisis

La página de logros en Trophy muestra cuántos usuarios han completado cada logro que has configurado.

Además, la página de análisis de cualquier métrica en Trophy incluye un gráfico que muestra el progreso de los usuarios a través de tus logros.

Obtener Soporte

¿Quieres ponerte en contacto con el equipo de Trophy? Contáctanos por correo electrónico. ¡Estamos aquí para ayudarte!

Guías de funcionalidades

Casos de uso

Cómo Crear una Funcionalidad de Logros

Requisitos previos

Configuración de Trophy

Instalación del SDK de Trophy

Rastreo de Interacciones de Usuarios

Visualización de Logros

Notificaciones Emergentes

Mostrar Logros del Usuario

Mostrar Todos los Logros

Estadísticas de Completado de Logros

Análisis

Obtener Soporte

​Requisitos previos

​Configuración de Trophy

​Instalación del SDK de Trophy

​Rastreo de Interacciones de Usuarios

​Visualización de Logros

​Notificaciones Emergentes

​Mostrar Logros del Usuario

​Mostrar Todos los Logros

​Estadísticas de Completado de Logros

​Análisis

​Obtener Soporte

Requisitos previos

Configuración de Trophy

Instalación del SDK de Trophy

Rastreo de Interacciones de Usuarios

Visualización de Logros

Notificaciones Emergentes

Mostrar Logros del Usuario

Mostrar Todos los Logros

Estadísticas de Completado de Logros

Análisis

Obtener Soporte