Autenticacion

Como autenticar tus requests a la API de SouthGames.

Todas las llamadas a la API requieren dos headers:

HeaderDescripcion
AuthorizationBearer <api_key> — tu API key
X-Org-IdEl slug o ID de tu organizacion

API Keys

Las API keys se generan desde Configuracion > Desarrollador en la consola. Cada key tiene un prefijo que indica su tipo:

PrefijoTipoUso
sg_live_ProduccionApp en produccion
sg_test_TestDesarrollo y pruebas

Generar una API key

  1. Ve a Configuracion > Desarrollador en la consola
  2. Haz clic en "Crear API Key"
  3. Asigna un nombre descriptivo
  4. Copia la key — solo se muestra una vez

Permisos (scopes)

Al crear una key eliges su nivel de permiso:

PermisoScopeQue permite
Acceso completo*Todos los endpoints (lectura y escritura) y el endpoint MCP
Solo metricasmetrics:readSolo lectura: la API de metricas y otros endpoints GET. No puede escribir ni usar MCP.

Una key Solo metricas (metrics:read) es de solo lectura: si intenta un endpoint de escritura (p. ej. /points/spend, /games/play) o el endpoint MCP (/api/mcp), recibe 403 con codigo INSUFFICIENT_SCOPE. Esta pensada para integraciones de extraccion de datos/BI. (No restringe la lectura a solo metricas: tambien puede llamar otros endpoints GET de la API.) Las keys creadas antes de existir los scopes se tratan como acceso completo.

Seguridad

  • Nunca expongas tu API key en codigo frontend o repositorios publicos
  • Usa variables de entorno para almacenar keys
  • Rota las keys periodicamente desde la consola
  • Puedes desactivar o eliminar keys sin afectar otras
  • Para integraciones de BI/extraccion de datos, usa una key Solo metricas

Ejemplo de request

curl -X POST https://southgames.ai/api/v1/clients/register \
  -H "Authorization: Bearer sg_live_xxxxxxxxxxxxxxxx" \
  -H "X-Org-Id: mi-empresa" \
  -H "Content-Type: application/json" \
  -d '{"externalId": "user_123", "email": "user@example.com"}'

Errores de autenticacion

CodigoHTTPDescripcion
MISSING_API_KEY401Falta el header Authorization
MISSING_ORG_ID401Falta el header X-Org-Id
INVALID_API_KEY401Key invalida o desactivada
API_KEY_EXPIRED401Key expirada
ORG_NOT_FOUND404Organizacion no encontrada
INSUFFICIENT_SCOPE403La key no tiene el permiso requerido para el endpoint
RATE_LIMITED429Se supero el limite de solicitudes de la key