Configuración de la API pública SchoolsBuddy
Ahora que su acceso a la API está habilitado, siga estos pasos para generar credenciales y administrar sus integraciones dentro del portal SchoolsBuddy .
Esta guía explica cómo configurar y administrar el acceso a la API en SchoolsBuddy . Este proceso permite que su equipo técnico se autentique mediante OAuth 2.0 y comience a conectar sus sistemas externos a SchoolsBuddy .
Para acceder a esta configuración se requieren permisos específicos; asegúrese de haber iniciado sesión como superadministrador de la organización antes de continuar.
Descripción general
El área de Administrador de API públicas está disponible para que los superadministradores de la organización la gestionen. En este centro de control, podrá crear, editar y proteger los clientes utilizados para las integraciones de datos de su centro educativo.
Conceptos clave
Antes de comenzar la configuración, confirme que se cumplen los siguientes requisitos previos:
- Has iniciado sesión como Superadministrador de la organización .
- Ya tienes lista la documentación técnica para configurar los permisos y ámbitos necesarios.
Navegación paso a paso
Consejos y buenas prácticas
- Entorno de prueba: Pruebe siempre su integración en un entorno de prueba, si está disponible, antes de conectarse a su instancia SchoolsBuddy en producción.
- Operaciones masivas: Revise detenidamente la documentación técnica antes de iniciar operaciones de escritura masiva para garantizar la integridad de los datos.
- Mantenimiento de credenciales: Dentro del Administrador de API, puede editar permisos, regenerar credenciales o deshabilitar/eliminar clientes para mantener la seguridad.
Advertencias y notas importantes
Acceso de seguridad: Las credenciales de la API proporcionan un acceso significativo a los datos de su escuela. Asegúrese de que solo el personal autorizado tenga acceso de superadministrador para gestionar esta configuración.
Compartir públicamente: Nunca compartas tu clave secreta de cliente públicamente; estas credenciales están vinculadas exclusivamente a tu instancia SchoolsBuddy y proporcionan acceso directo a tu ecosistema de datos.
Artículos relacionados
Preguntas frecuentes
¿Qué sucede si pierdo mi clave secreta de cliente?
Por motivos de seguridad, SchoolsBuddy no vuelve a mostrar la clave secreta del cliente. Deberá usar el Administrador de API para regenerar las credenciales de ese cliente.
¿Puedo limitar las funciones de la API?
Sí. Durante la configuración, puede definir permisos y ámbitos específicos para otorgar únicamente el acceso de lectura (GET) o escritura (POST/PUT) necesario para esa integración específica.
En resumen
- Acceda al Administrador de API a través de Configuración > Administrador de API .
- Genere credenciales creando un nuevo cliente con ámbitos específicos.
- Almacene los ID de cliente y las claves secretas de forma segura y nunca los comparta públicamente.
Tu integración SchoolsBuddy ya está lista para comenzar a sincronizar datos.
Relacionada con