Autenticación

Todas las peticiones a la API de Correo de Yolani requieren autenticación mediante una API key. Las API keys tienen un formato específico y pueden...

Formato de las API keys

Las API keys de Yolani tienen el siguiente formato:

  • Prefijo: yk-
  • Cuerpo: 64 caracteres hexadecimales (0-9, a-f)
  • Ejemplo: yk-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456

Método 1: Bearer Token

Envía la API key en el header Authorization como Bearer:

Authorization: Bearer yk-a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456

Método 2: Basic Auth

Envía la API key usando autenticación HTTP Basic. El usuario puede ser cualquier valor; la contraseña se ignora. Lo importante es que la API key vaya después de los dos puntos:

Authorization: Basic base64(api_key:)

En la práctica, codifica en Base64 la cadena yk-tu-api-key: (con los dos puntos al final, sin nada después). El servidor extrae la API key de la parte antes de los dos puntos en la cadena decodificada.

Ejemplo en Base64: Para la API key yk-abc123..., codificarías yk-abc123...: (con los dos puntos).

Cómo obtener API keys

Solicita una clave a soporte desde Yolani, o créala en el panel cuando el módulo de correo esté disponible. Pasos previstos:

  1. Inicia sesión en Yolani
  2. Abre la configuración del módulo de correo
  3. En API Keys, crea una clave nueva
  4. Asigna un nombre descriptivo
  5. Copia la clave al instante: solo se muestra una vez

Importante:

La API key se muestra solo una vez al crearla. Si no la copias en ese momento, tendrás que revocarla y crear una nueva.

Almacenamiento seguro

Las API keys se almacenan en el servidor como hashes SHA-256. Esto significa que ni siquiera Yolani puede recuperar tu clave original. Si la pierdes, deberás crear una nueva y actualizar tu integración.

Dominio asociado

Cada API key está asociada a un dominio específico. Solo podrás usar esa clave para enviar correos desde direcciones de ese dominio. Si tienes varios dominios, necesitarás una API key por dominio.