Autenticación

Nuestra API utiliza Token Based Authentication sobre HTTPS para la autenticación. Para tener acceso a nuestra API, necesitas crear y utilizar API keys específicas para cada entorno.

API Keys

Las API keys son tokens de autenticación que permiten el acceso a los diferentes recursos de la API de Soyio. Cada API key:

• Es específica para un entorno: sandbox o production
• Puede ser creada dinámicamente desde la API
• Tiene un alcance configurable (scopes) para limitar el acceso a endpoints específicos
• Incluye fechas de expiración (90 días por defecto en production, sin expiración en sandbox)

Identificación por Prefijo

Las API keys se identifican por su prefijo según el entorno:

• Sandbox: ak_sandbox_[identificador]
• Production: ak_live_[identificador]

Header de autenticación

Este tiene el siguiente formato:

Authorization: <api_key>

Donde api_key es la API key específica del entorno que deseas utilizar.

Ejemplo para Sandbox

Authorization: ak_sandbox_1B2M2Y8AsgTpgAmY7PhCfg

Ejemplo para Production

Authorization: ak_live_2C3N3Z9BthUpgBnZ8QiDgh

Gestión de API Keys

Puedes gestionar tus API keys tanto desde los siguientes endpoints:

• Crear nueva API key: POST /api_keys
• Listar todas las API keys: GET /api_keys
• Obtener detalles de una API key: GET /api_keys/{id}
• Actualizar una API key: PATCH /api_keys/{id}
• Revocar una API key: DELETE /api_keys/{id}

Importante

Usa HTTPS para todos los requests. Requests hechos mediante HTTP retornarán respuestas HTTP 403. ¡Mantén tus API keys en secreto! Una vez creada, el token secreto solo se muestra una vez durante la creación.

Buenas Prácticas

• Crea API keys separadas para cada aplicación o servicio
• Utiliza scopes específicos para limitar el acceso solo a los endpoints necesarios
• Rota tus API keys regularmente, especialmente en production
• Revoca inmediatamente las API keys comprometidas :::