Inicio Rápido de Joystick

Tiempo estimado para completar: 8 minutos.

1. Entender la Jerarquía

Componente	Descripción
Organización	- Una "Organización" representa tu empresa, estudio o grupo de trabajo. - Una Organización puede tener múltiples productos. - Los usuarios de todos tus productos pueden ser gestionados a nivel Organizacional. - Los usuarios pueden ser "Propietarios", "Editores" o "Miembros" de la Organización.
Producto	- Un "Producto" puede ser creado para cada aplicación o juego distintivo que estés desarrollando. - Un usuario puede crear o tener acceso a uno o más productos. - Un Producto es donde invitas a otros miembros de tu equipo a colaborar.
Entorno	- Cada producto puede tener múltiples "Entornos". - Estos pueden corresponder a cómo está configurado tu flujo de trabajo y pipeline. - Dentro de cada entorno, puede haber muchas configuraciones / contenidos.
Contenido	- El contenido es tu JSON. - El contenido se almacena en cada entorno. - Puedes empujar y sincronizar fácilmente el contenido de configuración entre entornos.
Claves API	- Las Claves API se provisionan y gestionan a nivel de entorno. - Cada entorno tendrá sus propias claves API que dan acceso al contenido de ese entorno solamente. - Para acceder a la misma configuración, en un entorno diferente, tendrás que cambiar las claves de entorno en tu instancia de aplicación.

2. Crear una Cuenta

Crea una cuenta aquí.

3. Crear un Producto

Un "Producto" es donde todas las configuraciones para una aplicación o juego en particular deben estar alojadas. Cuando inicies sesión por primera vez, tendrás una Organización vacía y la opción de crear un Producto.

Entrada	Descripción
Nombre del Producto	Un nombre amigable para el producto. Puede tener espacios.

Después de haber creado tu producto, se mostrará la tarjeta. Haz clic en ella para abrir el Producto.

4. Crear un Entorno

Un "Entorno" es un contenedor para tus configuraciones. Una configuración típica puede tener cuatro entornos: "Desarrollo", "QA", "Staging" y "Producción". Con Joystick, puedes sincronizar/promocionar fácilmente el contenido de configuración entre entornos. Vamos a crear un entorno para empezar.

Note

Un entorno debe albergar un conjunto completo de contenido de configuración requerido por tu producto/aplicación. Puedes crear tantos entornos como necesites para que coincidan con tu flujo de trabajo.

Entrada	Descripción
Nombre	Un nombre corto y amigable para este entorno.
Descripción	Información adicional corta que quieras agregar sobre este entorno y cómo puede ser utilizado.
Color e Icono	Utilizado para identificar visualmente un entorno. Por ejemplo, puedes querer establecer "Producción" como un color rojo.

Verás tu Tarjeta de Entorno. Haz clic en ella para entrar al Entorno.

5. Añadir una Configuración

El entorno está actualmente vacío. Añade tu primera pieza de configuración/contenido a Joystick aquí. Puede ser cualquier contenido JSON que desees servir a tu aplicación.

Este es el editor de contenido de configuración de Joystick. Puedes colocar cualquier configuración JSON válida aquí. No te restringimos a simples pares clave:valor.

Entrada	Descripción
Id de Contenido	Este Id de Contenido debe ser único por entorno. Este es el identificador utilizado para recuperar el contenido a través de la API.
Descripción	Describe para qué es esta versión de configuración para que otros puedan entender el cambio. Lo mejor es mantenerlo corto y descriptivo.
Carpeta	La carpeta donde se colocará este contenido. Puedes mover el contenido más tarde.

Intenta añadir este simple fragmento y luego guardar.

{
    "greeting": "¡Hola, mundo!"
}

Tipos de Contenido Soportados

Nosotros soportamos nativamente JSON con muchas características poderosas incluyendo validación, pruebas AB y protección de esquemas. Sin embargo, también soportamos cualquier formato de configuración de cadena incluyendo XML, YAML, INI, texto plano. Aprende más.

Haz clic en "Guardar" en la parte superior derecha y serás llevado al visor de contenido. La revisión superior indicada como "Activa" está disponible a través de la API.

Navegación

Las migas de pan de navegación están en la parte superior.

6. Generar una Clave API

Una Clave API te permite obtener tu contenido de un entorno. Haz clic en el nombre de tu entorno en la parte superior, luego en "Claves API del Entorno" para ir al gestor de Claves API. ¡Crea tu primera Clave API!

Entrada	Descripción
Nombre de la Clave	Un nombre corto y amigable para identificar esta clave y su uso.
Permisos de la Clave	Selecciona "Solo Lectura" para este ejemplo.

Notas Importantes

Una Clave API solo puede obtener contenido del entorno en el que fue creada.
Después de crear una Clave API, se te mostrará la clave solo una vez. Guarda tu API en un lugar seguro. No almacenamos claves API completas y no tenemos forma de recuperarlas. Tendrás que generar una nueva clave.

Después de haber creado tu clave, aparecerá en la lista. Las Claves API pueden ser revocadas desde aquí.

7. Obtener Tu Contenido vía API

¡Tenemos SDKs!

Tenemos SDKs para Javascript, Unity, Python y más. ¡Ve nuestros SDKs!.

Con tu API en mano, estás listo para obtener tu contenido. Nuestra API es ligera.

Solicitud

Punto Final

POST https://api.getjoystick.com/api/v1/config/:contentId/dynamic

Sustituye el :contentId indicado con el Id de Contenido de Configuración que creaste (Si sigues el ejemplo, el ContentId es simplemente "greetings"). El :contentId no es sensible a mayúsculas.

Encabezado

Encabezado	Valor	Requerido	Notas
`Content-Type`	application/json	Sí
`X-Api-Key`	Tu Clave API	Sí	La Clave API creada en el paso 6.

Cuerpo de la Solicitud

El cuerpo de la solicitud debe ser JSON, y no puede estar vacío. Debe contener al menos el siguiente fragmento. Si deseas contenido dinámico para segmentos o usuarios individuales, necesitarás usar los atributos u y p. Puedes aprender más sobre esto en nuestra guía de integración de la API.

Cuerpo de la Solicitud

{
    "u": "",
    "p": {}
}

Ejemplo

curl --location --request POST 'https://api.getjoystick.com/api/v1/config/:contentId/dynamic' \
--header 'X-Api-Key: TU-CLAVE-API' \
--header 'Content-Type: application/json' \
--data-raw '{"u": "", "p": {}}'

Recibirás de vuelta el contenido gestionado en Joystick.

Solución de Problemas

¿Tienes problemas? Consulta nuestra guía de solución de problemas.

Respuesta

Por defecto, tu contenido se devuelve como el objeto "data" en el cuerpo de la respuesta.

Respuesta de Ejemplo

{
    "data":
    {
        "saludo": "¡Hola, mundo!"
    },
    "hash": "2277e0d4",
    "meta":
    {
        "uid": 0, "mod": 0, "seg": []
    }
}

Los parámetros adicionales son para segmentación y pruebas AB; pueden ser opcionalmente desactivados. Consulta la Referencia de la API para otras opciones...

Obtén tu configuración sin el envoltorio "data".
Obtén tu configuración serializada.
Obtén varias piezas de configuración al mismo tiempo.

¿Qué Sigue?

Esto es solo una muestra de las características que tenemos en Joystick.