SouthGamesSouthGames/Docs
Iniciar Sesion

Resumen de la API

Referencia completa de la API REST de SouthGames.

La API REST de SouthGames permite integrar gamificacion y loyalty desde cualquier plataforma.

Base URL

https://southgames.ai/api/sdk

Autenticacion

Todas las llamadas requieren:

Authorization: Bearer <api_key>
X-Org-Id: <org_slug>
Content-Type: application/json

Ver Autenticacion para mas detalles.

Formato de respuesta

Respuestas exitosas:

{
  "success": true,
  "data": { ... }
}

Errores:

{
  "success": false,
  "error": {
    "message": "Descripcion del error",
    "code": "ERROR_CODE"
  }
}

Endpoints

Clientes

MetodoRutaDescripcion
POST/clients/registerRegistrar o actualizar un cliente identificado
POST/clients/register-deviceRegistrar un dispositivo anonimo
POST/clients/heartbeatActualizar lastSeenAt e incrementar sesiones
GET/clients/tierObtener tier y XP del cliente
POST/clients/logoutRemover device token (cerrar sesion)

Campanas y juegos

MetodoRutaDescripcion
GET/campaignsListar campanas activas
POST/games/playEjecutar una jugada

Codigos

MetodoRutaDescripcion
POST/codes/redeemCanjear un codigo promocional

Puntos

MetodoRutaDescripcion
GET/points/balanceConsultar saldo de puntos
GET/points/historyHistorial de puntos
POST/points/spendGastar puntos
POST/points/earnGanar puntos manualmente

Misiones

MetodoRutaDescripcion
GET/missionsListar misiones activas con progreso
POST/missions/claimReclamar recompensa de mision completada

Referidos

MetodoRutaDescripcion
GET/referrals/codeObtener o crear codigo de referido
POST/referrals/applyAplicar un codigo de referido
GET/referrals/statusEstado y lista de referidos

Notificaciones

MetodoRutaDescripcion
GET/notifications/in-appNotificaciones in-app del cliente
POST/notifications/in-app/eventsTrackear eventos in-app (shown, dismissed, cta_click)
POST/notifications/push/eventsTrackear eventos push (click, dismiss)

Eventos y journeys

MetodoRutaDescripcion
POST/events/trackTrackear un evento custom
POST/journeys/eventsEnviar evento a journeys