Saltar al contenido principal

Tipos de claves de API

La API de aplicación acepta dos tipos de claves de API: Usa claves de API de aplicación cuando quieras que los usuarios finales o las aplicaciones cliente llamen a la API de aplicación con permisos limitados a un solo usuario. Usa claves de API de administrador para integraciones de confianza en el servidor que necesiten un acceso amplio.

Claves de API de aplicación

Las claves de API de aplicación tienen alcance de un usuario específico. Cada clave solo puede realizar operaciones de la API de aplicación en nombre del usuario para el que se creó, lo que permite exponerlas de forma segura en entornos del lado del cliente. Las claves de API de aplicación no se pueden usar con la API de administrador.

Crear claves de API de aplicación

Crea claves de API de aplicación con la API de administrador. Esa solicitud se autentica con una clave de API de administrador. Puedes crear claves para un máximo de 100 usuarios por solicitud. El valor completo de la clave se devuelve una sola vez al crearla y no se puede recuperar de nuevo: guárdalo de forma segura o entrégalo al cliente de inmediato.
Una respuesta correcta incluye el ID de la clave (que se usa más adelante para eliminarla), el ID del usuario, la clave completa y un prefijo legible:

Anatomía de una clave de API de aplicación

Cada clave de API de aplicación consta de 2 partes separadas por un punto:
  • El prefijo identifica la clave (por ejemplo, app_XXXXX) y se puede registrar o mostrar sin riesgo.
  • El cuerpo es la parte secreta y solo se muestra una vez, cuando creas la clave.
Al usar la API, debes enviar ambas partes de tu clave de API de aplicación en el encabezado X-API-KEY.

Autenticación de solicitudes

Incluye la clave de API de aplicación completa en el encabezado X-API-KEY de las solicitudes a la Application API, o pásala al inicializar un cliente del SDK. La clave solo autoriza operaciones para el usuario al que está asociada; las solicitudes para otros usuarios devuelven un error.
Si no pasas una clave de API, o si tu clave de API no es válida, recibirás un código de respuesta 401.

Eliminación de claves de API de aplicación

Elimina las claves de API de aplicación por ID con la Admin API. Usa el UUID que se devolvió cuando se creó la clave.
Una vez que se eliminan las claves de API, no se pueden recuperar.

Obtener soporte

¿Quieres ponerte en contacto con el equipo de Trophy? Comunícate con nosotros por correo electrónico. ¡Estamos aquí para ayudarte!