Saltar al contenido principal

Resumen para desarrolladores

Te damos la bienvenida a la documentación para desarrolladores de Joryio. Esta guía te ayudará a integrar Joryio en tus aplicaciones.

¿Qué puedes crear?​

Con la plataforma para desarrolladores de Joryio, puedes:

  • Registrar el comportamiento de los usuarios en web, iOS y Android.
  • Gestionar perfiles de usuario y atributos mediante programación.
  • Enviar eventos personalizados para impulsar la segmentación y la analítica.
  • Integrarte con webhooks para recibir notificaciones de eventos en tiempo real.
  • Activar campañas mediante la API.
  • Consultar datos analíticos para crear dashboards personalizados.

Arquitectura de la plataforma​

Data in
Your appsSDK keys
Web · iOS · Android · React Native
Your backendAPI keys
REST API
Store platforms
Shopify · WooCommerce · Magento
Bulk import
CSV · JSON
Warehouse sync
Snowflake · BigQuery
Joryio platform
Joryio
Profiles & events
Segments
Journeys (Canvas)
Campaigns
Analytics & ML
Data out
Messages
Email · SMS · WhatsApp · Push · In-app · Wallet
Webhooks
journey nodes & event streams
Data streaming
Snowflake · BigQuery · Redshift · S3 · Kafka · Mixpanel · Amplitude

One track() call powers every surface — a Kafka-based streaming spine fans events out in real time.

En cuanto llegan, los eventos se distribuyen a la analítica, la segmentación de audiencias, las señales de recompensa de ML y la evaluación de disparadores de recorridos. Esta misma base alimenta Data Streaming, que envía tus eventos a tu propio almacén de datos, almacenamiento o stack analítico, y la sincronización de almacén de datos, que incorpora los datos que ya tienes.

Autenticación​

Joryio utiliza dos tipos de autenticación:

Claves de SDK (lado cliente)​

Para registrar actividad desde aplicaciones web y móviles:

jry_sdk_web_abc123...     (Web SDK)
jry_sdk_ios_def456...     (iOS SDK)
jry_sdk_android_ghi789... (Android SDK)

Seguridad: se pueden incluir de forma segura en código del lado cliente. Solo permiten operaciones de seguimiento.

Claves de API (lado servidor)​

Para llamadas de API de servidor a servidor:

jry_live_xyz789... (Production)
jry_test_abc123... (Testing)

Seguridad: deben mantenerse secretas. No las expongas nunca en código del lado cliente. Dan acceso completo a todas las operaciones de la API.

Mantén las claves de API en secreto

No incluyas nunca claves de API en el control de versiones ni las expongas en código del lado cliente. Usa variables de entorno.

Integración rápida​

1. Seguimiento web​

import JoryioSDK from '@joryio/web-sdk';

const joryio = new JoryioSDK({
  sdkKey: 'jry_sdk_web_your_key_here'
});

// Identify user
joryio.identify('user_123');
joryio.setAttributes({
  email: 'user@example.com',
  plan: 'premium',
});

// Track event
joryio.track('Button Clicked', {
  button: 'signup',
  page: 'homepage'
});

2. API del lado servidor​

const response = await fetch('https://api-eu1.joryio.com/users', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer jry_live_your_api_key_here'
  },
  body: JSON.stringify({
    userId: 'user_123',
    email: 'user@example.com',
    attributes: {
      plan: 'premium',
      signupDate: '2024-01-15'
    }
  })
});

SDK y bibliotecas​

SDK oficiales​

PlataformaEstadoDocumentación
Web (JavaScript)DisponibleGuía del SDK web
iOS (Swift)DisponibleGuía del SDK para iOS
Android (Kotlin)DisponibleGuía del SDK para Android
React NativeDisponibleGuía del SDK para React Native

API REST​

API REST completa para todas las operaciones:

  • Referencia de la API
  • URL base: https://api-eu1.joryio.com
  • Formato: JSON
  • Autenticación: clave de API Bearer (Authorization: Bearer jry_live_...)

Conceptos fundamentales​

Cada concepto cuenta con su propia guía; esta página sirve como mapa:

  • Apps: una por plataforma, cada una con su propia clave de SDK.
  • Usuarios: perfiles, atributos, alias y la API para crear o actualizar.
  • Eventos: convenciones de nombres, propiedades, identify frente a track y depuración.
  • Segmentos: grupos dinámicos de usuarios basados en atributos y comportamiento.

Flujo de desarrollo​

1. Entorno de desarrollo​

# Usa claves de API de prueba
export JORYIO_API_KEY=jry_test_abc123...

Activa el modo de depuración en el SDK web:

const joryio = new JoryioSDK({
  sdkKey: 'jry_sdk_web_test_...',
  enableDebug: true
});

2. Pruebas​

  • Usa claves de API de prueba durante el desarrollo.
  • Crea segmentos y campañas de prueba.
  • Verifica los eventos en el dashboard.
  • Prueba los endpoints de webhook localmente (con ngrok).

3. Implementación en producción​

  • Cambia a las claves de API de producción.
  • Desactiva el modo de depuración.
  • Supervisa las tasas de error.
  • Configura webhooks para los eventos críticos.

Límites de velocidad y errores​

El comportamiento de los límites de velocidad (429 + Retry-After), el cuerpo de error estándar y los códigos de estado se documentan en un único lugar, en el resumen de la API: Límites de velocidad · Códigos de estado HTTP.

Enviar eventos a otros sistemas​

Para recibir eventos de Joryio en tu propio endpoint en tiempo real, añade un destino de webhook en Data Streaming: cada evento se envía mediante POST en JSON a tu URL HTTPS. Los recorridos también pueden llamar a tus sistemas para cada contacto con el nodo Webhook, y puedes inspeccionar y reintentar entregas fallidas en Configuración → Registros y monitorización (Reintentos de webhook).

Prácticas recomendadas​

Soporte y recursos​

Próximos pasos​

  1. Integra el SDK web.
  2. Configura el seguimiento de usuarios.
  3. Crea tu primer segmento.
  4. Envía una campaña.