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 a través de la Herramienta de Gestión de Claves API.
¿Qué es una 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 de 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 para la API de Awardco incluyen:
- Subir archivos de usuarios a Awardco.
- Obtener informes en formato .csv o .json.
- Automatizar premios y reconocimientos.
- Recuperar información del feed social para mostrarla.
- Interactuar con la plataforma para crear aplicaciones.
Para enviar un archivo usando una API, el archivo debe ser accesible y estar codificado correctamente. Hay tres métodos principales para manejar esto:
- Almacenar el archivo en un servidor FTP o servidor accesible públicamente.
- Usar un servicio API (por ejemplo, Postman) para construir la solicitud.
- Usar lenguajes de programación como C#, cURL o JavaScript para enviar la solicitud.
Aunque la API proporciona un acceso potente a la plataforma Awardco, los clientes son totalmente responsables de su uso.
Para saber más, visita nuestra Documentación Pública de la API.
Habilitar el 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:
- Haz clic en el botón Admin en la parte superior derecha de la página principal.
- Navega a la pestaña Configuración.
- Selecciona Permisos en el menú lateral izquierdo.
- Haz clic en el ícono de tres puntos junto al rol que deseas editar y elige Editar.
- Ve a la configuración de Permisos y marca la casilla junto a ‘Claves API’.
- Haz clic en Guardar y Aplicar.
Acceder 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 API específicas para diversas acciones, como enviar reconocimientos, obtener 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:
- Selecciona el botón 'Admin' en la parte superior derecha de la página principal.
- Haz clic en la pestaña 'Configuración'.
- Haz clic en 'Claves API' en el menú lateral 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, obtener 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 hasheadas y saladas para seguridad (no se almacenan en texto plano).
- Eliminar claves API según sea necesario.
- Nota que los usuarios que están suplantando a otros no pueden generar claves API.
- Enviar claves API de forma segura a personas de confianza.
Crear una Nueva Clave API
Para crear una nueva clave API:
- Haz clic en el botón + Nueva Clave API en la página de Claves API.
- Ingresa un Nombre para la clave.
- Selecciona los permisos que la clave debe tener.
- Si estás configurando una clave API para una integración de Awardco, consulta la sección de Permisos Requeridos para Integración más abajo.
- Establece el período o fecha de expiración de la clave.
- La fecha máxima de expiración es tres años desde la fecha actual. Se recomienda cambiar las claves API regularmente.
- Haz clic en Siguiente.
- Elige generar la clave inmediatamente o enviarla de forma segura a otra persona.
- 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 mejores prácticas y consejos para claves API, consulta este artículo de soporte.
Gestionar Claves API
Ver y Editar Detalles de Claves API
Para ver detalles de una clave API:
- Haz clic en el nombre de la clave API 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.
Revocar 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:
- Haz clic en el ícono de tres puntos junto a la clave.
- Selecciona Revocar.
- Confirma haciendo clic en Revocar Clave API.
Las claves revocadas se moverán a la pestaña Archivadas.
Reenviar una Clave API
Si una clave API muestra un estado de “No Aceptada” o no fue aceptada en 24 horas, puedes reenviarla.
- Haz clic en el ícono de tres puntos junto a la clave.
- Selecciona Reenviar. La clave API será reenviada a la dirección de correo electrónico especificada cuando se creó la clave.
Clonar una Clave API
Para clonar una clave API:
- Haz clic en el ícono de tres puntos junto a la clave y selecciona Clonar.
- Actualiza el nombre, permisos o fecha de expiración según sea necesario.
- Sigue el mismo proceso para generar o enviar la clave como se describe en “Crear una Nueva Clave API.”
Ver 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 ser restauradas, pero pueden ser clonadas 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 movida de Admin > Configuración > Configuración Avanzada a la nueva Página de Gestión de Claves API. Ahora puedes encontrarla al final de la página de Configuración API (Admin > Configuración > Claves API).
Cómo Migrar desde Claves API Clásicas
Para realizar una transición segura desde tu clave API clásica:
- Crear Nuevas Claves con Permisos: Genera claves API separadas para cada integración usando los pasos en "Crear una Nueva Clave API" arriba. Asegúrate de que cada clave tenga solo los permisos específicos necesarios para su integración.
- Actualizar tus Integraciones: Reemplaza la clave API clásica en cada integración con la clave nueva con permisos adecuada.
- Eliminar 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 Integración
Lista de integraciones que usan claves API y el permiso requerido para cada una:
- ScreenCloud - Feed Personalizado
- Qualtrics - Reconocimiento Externo
- Speakap - Feed Social
- Sworkit - Recompensa Masiva
- Paycom - Importar Usuarios
- Awardco Connect (para todos los clientes) - Un representante de Awardco te guiará sobre los permisos específicos que tu clave API requiere. En la mayoría de los casos, solo se necesitan algunos permisos.
If you have any questions, please contact Awardco Admin Support.