Contact Support

Creación y Gestión de Claves API

Actualización

Las tareas manuales en la plataforma Awardco, como subir archivos de usuarios o generar informes, pueden ser tediosas y consumir mucho tiempo. Al usar claves API, puedes automatizar estos procesos, ahorrando tiempo y esfuerzo. Este artículo explica qué son las claves API, sus capacidades y cómo puedes usarlas dentro de tu organización mediante la Herramienta de Gestión de Claves API.

Nota: Los permisos que selecciones para tu clave API dependerán de los productos Awardco que utilices:

  • Awardco Recognition: Es posible que necesites una amplia gama de permisos, incluyendo feeds sociales, publicación de reconocimientos e informes.
  • Awardco Engage: Dado que Engage se enfoca en encuestas para empleados, tus necesidades de API probablemente se limiten estrictamente a la Gestión de Usuarios para mantener actualizadas las audiencias de las encuestas.

 

  1. ¿Qué es API?
  2. Habilitación del permiso de clave API
  3. Acceso a la Herramienta de Gestión de Claves API
  4. Creación de una nueva clave API
  5. Gestión de claves API
  6. Transición desde claves API clásicas
  7. Permisos requeridos para integraciones

 

¿Qué es API?

API (Interfaz de Programación de Aplicaciones) es una forma para que dos programas se comuniquen. Proporciona un conjunto de comandos y solicitudes que un programa (como Awardco) puede aceptar desde fuentes externas. La mayoría de las aplicaciones móviles usan APIs para comunicarse con sus sistemas principales.

La API de Awardco utiliza HTTP, el mismo protocolo usado por sitios web, lo que simplifica la comunicación y permite realizar llamadas API directamente desde un navegador.

La API de Awardco soporta dos tipos principales de solicitudes:

  • GET: Solicita información de la base de datos, como obtener informes en formato .csv o .json.
  • POST: Actualiza información en la base de datos. Por ejemplo, permite actualizar usuarios, publicar reconocimientos o gestionar recompensas.

 

¿Qué es posible con la API?

Los casos de uso comunes incluyen:

  • Gestión de usuarios: Sincronización de datos de empleados (esencial para Engage y Recognition).
  • Automatización: Automatización de premios y reconocimientos (solo Recognition).
  • Feeds sociales: Recuperación de información de feeds para pantallas externas (solo Recognition).

 

Para enviar un archivo usando una API, el archivo debe ser accesible y estar correctamente codificado. Hay tres métodos principales para manejar esto:

  1. Almacenar el archivo en un servidor FTP o en un servidor accesible públicamente.
  2. Usar un servicio API (por ejemplo, Postman) para construir la solicitud.
  3. Usar lenguajes de programación como C#, cURL o JavaScript para enviar la solicitud.

 

Aunque la API proporciona acceso poderoso a la plataforma Awardco, los clientes son completamente responsables de su uso.

 

Para saber más, visita nuestra Documentación Pública de la API.

 

Habilitación del permiso de clave API

Por defecto, solo los usuarios Super Admin pueden gestionar claves API. Para permitir que otros roles gestionen y creen claves API:

  1. En la página principal, selecciona el botón Admin en la parte inferior del menú de navegación izquierdo.
  2. Selecciona “Usuarios”, luego “Permisos” en el menú de navegación izquierdo.
  3. Haz clic en el ícono de tres puntos junto al rol que quieres editar y elige Editar.
  4. Navega a la configuración de Permisos y marca la casilla junto a ‘Claves API’.
  5. Haz clic en Guardar y Aplicar.

 

 

Acceso a la Herramienta de Gestión de Claves API

Awardco proporciona una herramienta dedicada para la gestión de claves API que te permite administrar claves específicas para diversas acciones, como enviar reconocimientos, extraer feeds o crear usuarios. En lugar de usar una sola clave API con todos los permisos, Awardco divide las claves en acciones separadas según tus necesidades.

 

Para acceder a la herramienta de Gestión de Claves API:

  1. En la página principal, selecciona el botón Admin en la parte inferior del menú de navegación izquierdo.
  2. Selecciona “Plataforma”, luego “Integraciones” y después “Configuración API” en el menú de navegación izquierdo.

 



 

En la Herramienta de Gestión de Claves API, puedes:

  • Ver y gestionar claves API específicas para diferentes tareas (por ejemplo, enviar reconocimientos, extraer informes).
  • Asignar roles y permisos para quién puede gestionar claves API dentro de tu organización.
  • Rastrear quién creó cada clave API y cuándo fue creada.
  • Asegurar que las claves API estén cifradas y protegidas (no se almacenan en texto plano).
  • Eliminar claves API según sea necesario.
  • Tener en cuenta que los usuarios que se hacen pasar por otros no pueden generar claves API.
  • Enviar claves API de forma segura a personas de confianza.

 

Creación de una nueva clave API

Para crear una nueva clave API:

  1. Haz clic en el botón “+ Nueva Clave API” en la página de Claves API.
  2. Ingresa un Nombre para la Clave.
  3. Selecciona los permisos que debe tener la clave.
  • Para clientes de Recognition: Selecciona los permisos relevantes para tu integración (por ejemplo, Feed Personalizado para ScreenCloud).
  • Para clientes solo de Engage: Normalmente solo necesitas permisos relacionados con la transferencia de datos de usuarios para mantener actualizadas las audiencias de tus encuestas. Recomendamos seleccionar solo:
    • activar usuario, archivar usuario, crear usuario, importar usuarios, foto de perfil, restablecer contraseña, usuario existe y usuarios.
  1. Establece el período o fecha de expiración de la clave.
    • La fecha máxima de expiración es tres años a partir de la fecha actual. Se recomienda cambiar las claves API regularmente.
  2. Haz clic en Siguiente.
  3. Elige generar la clave inmediatamente o enviarla de forma segura a otra persona.
  4. Revisa los detalles y completa el proceso haciendo clic en Generar Clave API o enviándola de forma segura.

 

 

Importante: Copia y guarda la clave API de forma segura inmediatamente después de generarla. Por razones de seguridad, no se mostrará nuevamente. Para más información sobre buenas prácticas y consejos para claves API, consulta este artículo de soporte.  

 

Gestión de claves API

Visualización y edición de detalles de la clave API

Para ver los detalles de una clave API, haz clic en el nombre de la clave para abrir una ventana de detalles que muestra:

  • Nombre de la clave.
  • Los primeros seis dígitos de la clave.
  • Nombre del creador.
  • Estado.
  • Permisos.
  • Fecha de creación.
  • Fecha de expiración.
  • Fecha de último uso.

 

 

Para editar el nombre o la fecha de expiración de una clave API, haz clic en Editar y realiza los cambios. Guarda los cambios cuando termines.

 

 

Revocación de una clave API

Revocar una clave API la desactiva permanentemente, haciendo que cualquier integración asociada deje de funcionar. Esta acción no puede deshacerse.

 

Para revocar una clave API:

  1. Haz clic en el ícono de tres puntos junto a la clave.
  2. Selecciona “Revocar.”
  3. Confirma haciendo clic en “Revocar Clave API.”

 

Las claves revocadas se moverán a la pestaña Archivadas.

 

 

Reenvío de una clave API

Si una clave API muestra un estado de “No Aceptada” o no fue aceptada dentro de 24 horas, puedes reenviarla.

  1. Haz clic en el ícono de tres puntos junto a la clave.
  2. Selecciona “Reenviar.” La clave API será reenviada a la dirección de correo electrónico especificada cuando se creó la clave.

 

Clonación de una clave API

Para clonar una clave API:

  1. Haz clic en el ícono de tres puntos junto a la clave y selecciona “Clonar.”
  2. Actualiza el nombre, permisos o fecha de expiración según sea necesario.
  3. Sigue el mismo proceso para generar o enviar la clave como se describe en “Creación de una nueva clave API.”

 

 

Visualización de claves archivadas

Para ver claves API revocadas o archivadas, navega a la pestaña Archivadas en la configuración de Claves API. Las claves revocadas no pueden restaurarse, pero pueden clonarse para crear un duplicado.

 

 

Transición desde claves API clásicas

Aunque las claves API clásicas seguirán funcionando por ahora, recomendamos migrar al nuevo sistema para mayor seguridad y mejor control sobre tus integraciones.

 

Encontrar tu clave API clásica

Tu clave API clásica ha sido trasladada a la nueva página de Gestión de Claves API. Ahora puedes encontrarla al final de la página de Configuración API.

 

 

Cómo migrar desde claves API clásicas

Para hacer una transición segura desde tu clave API clásica:

  1. Crear nuevas claves con permisos: Genera claves API separadas para cada integración usando los pasos en "Creación de una nueva clave API" arriba. Asegúrate de que cada clave tenga solo los permisos específicos necesarios para su integración.
  2. Actualiza tus integraciones: Reemplaza la clave API clásica en cada integración con la clave nueva y con permisos adecuados.
  3. Elimina tu clave API clásica: Una vez que todas las integraciones estén actualizadas, haz clic en el botón "Eliminar Clave API Clásica" al final de la página de Configuración API.

 

Permisos requeridos para integraciones

Una lista de integraciones que usan claves API y el permiso requerido para cada una:

 

 

 

If you have any questions, please contact Awardco Admin Support.

Relacionada con