Búsqueda

API pública de OpenApply y funcionalidad ampliada

The Faria Team
  • Actualización

OpenApply ofrece una API pública para que las escuelas accedan a sus datos y archivos de forma segura. Tanto si cuentan con un equipo de programación propio (¡o, más probablemente, con un programador independiente con mucho talento!) como si utilizan servicios de terceros para desarrollar su infraestructura, pueden integrarse con OpenApply a través de la API pública.

Faria Education Group ofrece soporte para la API pública directamente desde la configuración de su cuenta OpenApply en: Configuración > Desarrollar > API pública o Documentación de la API.

Captura de pantalla: Faria Education Group ofrece soporte para la API pública directamente desde la configuración de su cuenta de OpenApply.

Además de un conjunto completo de API públicas, también ofrecemos artículos de soporte que demuestran cómo utilizarlas para realizar las tareas más solicitadas.

A continuación se muestran algunos ejemplos de instrucciones.

Explorando las API Faria Education Group : Portal de integraciones

Faria Education Group ofrece API robustas para OpenApply , ManageBac y SchoolsBuddy , que satisfacen diversas necesidades de integración y automatización. Faria recomienda comenzar con el Portal de Integraciones para una experiencia optimizada basada en navegador, que incluye pruebas de endpoints en tiempo real con sus propias credenciales.

Portal de integraciones: El enfoque recomendado

El Portal de Integraciones está diseñado para la exploración interactiva de API y las pruebas en tiempo real, directamente en su navegador.

Beneficios clave:

  • No requiere instalación de software: Todo funciona en tu navegador.
  • Botón "Pruébalo" en directo: Prueba al instante los puntos finales de la API y observa las respuestas reales.
  • Gestión segura de credenciales: autentíquese utilizando sus propias claves API o credenciales OAuth.
  • Retroalimentación inmediata: Solucione problemas y comprenda el comportamiento de la API en tiempo real.

Cómo empezar:

  1. Visite el Portal de Integraciones .
  2. Seleccione su producto ( OpenApply , ManageBac , SchoolsBuddy ).
  3. Consulta la documentación de la API y elige un punto final.
  4. Haz clic en el botón “Probar” .
  5. Introduzca sus credenciales de autenticación (consulte a continuación las instrucciones de configuración).
  6. Complete los parámetros requeridos y envíe la solicitud.
  7. Vea la respuesta en directo directamente en el portal.

Configuración de autenticación:

  • OpenApply v3:
  • ManageBac+ v2:
  • SchoolsBuddy :
    • Ve a SchoolsBuddy > Configuración > Administrador de API > Haz clic en "Agregar"
    • Genera tu ID de cliente y tu clave secreta.

    • Guía de autenticación de la API SchoolsBuddy

Cómo recuperar archivos vinculados a estudiantes desde OpenApply a través de la API

Problema: OpenApply se utiliza como punto de entrada en el proceso de admisión, donde los padres suben fotos de pasaporte y otros datos. Le gustaría poder almacenar esos archivos en otro sistema, o quizás subirlos a la plataforma SIS o MIS de su escuela.

Solución: OpenApply dispone de una función de exportación que permite exportar todos los archivos de forma masiva, pero si busca un proceso automatizado, puede utilizar las API para lograrlo.

Notas:

  • Acceso a la API habilitado en OpenApply (se requieren permisos de administrador).
  • ID de cliente y secreto de OAuth 2.0 generados en OpenApply :
  • Familiaridad con las solicitudes de API y la autenticación.

Guía de autenticación de API

Pasos a seguir:

  1. Admitimos el uso de la API para obtener toda la información del estudiante, incluyendo filtros y actualizaciones desde la última llamada. Esta información incluye un enlace secreto a los archivos PDF enviados con el formulario de solicitud.
  2. A continuación, podrá descargar estos archivos de forma segura, guardarlos en el disco duro o subirlos a la plataforma de destino.

Recuperar archivos de estudiantes a través de la API
Para exportar archivos para un estudiante específico:

 OBTENER /api/v3/students/{id}/files
  • Reemplace {id} con el ID de la base de datos OpenApply del estudiante.
  • Utilice el parámetro since_date para obtener solo los archivos actualizados desde su última exportación.

Ejemplo:

 curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \
-H "Autorización: Portador YOUR_ACCESS_TOKEN"

La respuesta incluye metadatos y URL seguras para cada archivo, que puede descargar y procesar según sea necesario.

Referencia de la API – Archivos

Automatice y programe las exportaciones.

  • Utilice el parámetro since_date para obtener solo los archivos nuevos o actualizados.
  • Programa tu integración para que se ejecute a intervalos regulares (por ejemplo, todas las noches) para mantener actualizado tu sistema de destino.
  • Almacene las credenciales de la API de forma segura y rótelas según sea necesario.

Mejores prácticas de seguridad

Cómo descargar campos personalizados y buscar por campos personalizados

Problema: Con OpenApply , las escuelas pueden crear una cantidad ilimitada de campos personalizados que se pueden completar con datos valiosos. Si bien OpenApply también admite amplias funciones de exportación, para automatizar procesos, ¿cómo podemos usar la API para gestionar nuestros flujos de trabajo de datos?

Solución: Este artículo muestra cómo encontrar información en campos personalizados mediante la API OpenApply con autenticación v3 . El endpoint de estudiantes incluye todos los campos personalizados y sus valores, si están presentes para ese estudiante. Además, puede usar un endpoint de búsqueda para recuperar los estudiantes cuyos valores personalizados coincidan con una cadena de texto.

Share

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 6 de 10