En esta documentación se proporcionan instrucciones sobre cómo utilizar la nueva API de asignación de dominios de migración. Este flujo de trabajo permitirá la migración de una o más URL de enlace 1.1 a un dominio de registro 1.3 diferente, llenando el vacío exacto de los requisitos de coincidencia de dominio.
Lo que puede hacer
Esta API de mapeo de dominios de migración permitirá la migración de una o más URL de enlaces heredados a un dominio de registro de Advantage diferente. Los casos de uso incluyen agregar, eliminar o actualizar dominios heredados y hacer que varias URL de enlaces heredados migren a un dominio de registro de ventaja diferente. Una vez completada esta asignación, las migraciones se pueden completar a través de los procesos de migración normales de copia, importación o manualmente con el Migrar botón.
Por ejemplo, los enlaces con las siguientes URL de enlaces heredados:
- Domain1.example.com, y
- Domain2.example2.com
Se puede migrar al siguiente dominio de registro:
Tabla 1: Ejemplos de migración disponibles a través de la API de asignación de dominios de migración.
Ejemplo de un caso de usuario | URL de enlace heredada | Dominio de registro Advantage | Dominio mapeado | URL de enlace después de la migración |
|---|
Cambio de subdominio | subdomain1.primary.com/path1 | domain3.com | domain1.com | domain3.com/path1 |
Subdominio | subdomain1.domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Eliminación de subdominios y cambio de dominio | domain2.com/path1 | domain3.com | domain2.com | domain3.com/path1 |
Mapeo de URL de enlaces heredados múltiples | domain2.com; subdomain1.domain2.com | domain3.com | domain2.com | domain3.com |
Lo que no puede hacer
Esta funcionalidad de migración adicional no permite que se actualice la ruta de acceso ni que se actualicen los parámetros personalizados a través del proceso de migración. Como se muestra en la tabla anterior, la ruta de acceso de la URL de enlace heredada se transfiere a la URL de enlace después de la migración. Esta API adicional solo llena el vacío exacto de coincidencia de dominio; Todas las demás limitaciones y casos de uso descritos en el Documentación de migración de LTIy Preguntas frecuentes sobre la migración todavía se aplican.
La API de migración (que migra un solo enlace a la vez) no funciona con dominios heredados asignados.
Cómo funciona
La URL del enlace heredado se puede encontrar en el nivel del curso. Vaya a Administrador del curso >Herramientas de aprendizaje externas > Administrar enlaces de herramientas (heredado) y selecciona tu enlace.
Figura: Un ejemplo de una URL de enlace heredada de LTI 1.1.
Para ver el dominio de registro de Advantage, vaya a Herramientas de administración > Administrar la extensibilidad > Ventaja de LTI y seleccione su registro.
Figura: Un ejemplo de un dominio de registro LTI 1.3 Advantage en el Editar herramienta de prueba LTI diálogo.
La migración solo se intenta cuando las implementaciones son compartidas. Es posible que tenga que comprobar las reglas de uso compartido de una implementación; El cliente debe proporcionar el contexto correcto para el lugar donde se necesita la migración.
Del Ventaja de LTI , haga clic en Registro de herramientas Advantagey navegue hasta Ver implementaciones.
Seleccione su implementación y asegúrese de que se comparta con el destino de migración agregando unidades de organización en el archivo Hacer que la herramienta esté disponible para sección. Enlaces de migración automática debe estar habilitado.
Figura: El Hacer que la herramienta esté disponible para sección
La URL del enlace después de la migración se puede encontrar en el nivel del curso. Vaya a Administrador del curso > Herramientas de aprendizaje externas > Ventaja de LTI y selecciona tu enlace.
Figura: El Editar enlace AGS con fechas donde puede localizar la URL del enlace después de la migración.
Una vez asignados los dominios heredados, las migraciones se pueden completar a través de los procesos de migración existentes, por supuesto, copiar, importar o manualmente mediante el Migrar en el nivel del curso Administrar enlaces de herramientas (heredado) página.
Pasos para ejecutar
1. Confirme si la coincidencia exacta del dominio es la única limitación. La ruta de acceso y los parámetros personalizados no se pueden actualizar. El Administrar los registros de herramientas LTI Advantage Se requiere permiso.
2. Con Postman o cualquier otra herramienta de prueba de API, utilice la API GET para encontrar todos los registros de la instancia. A continuación, copie el ID de cliente del dominio de registro de Advantage deseado que se bloqueó anteriormente por el requisito de coincidencia exacta de dominio. Este es el dominio de registro LTI Advantage.
GET /d2l/api/le/(versión)/ltiadvantage/registro/ <br/>
3. Use la nueva API Mapping Get para obtener los registros disponibles para ese ClientId:
GET/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Esta API devuelve una matriz JSON de cadenas de dominio heredadas que están configuradas para un registro de LTI Advantage determinado; Esta solicitud inicial debe devolver un resultado vacío.
4. Para asignar una URL de enlace heredada a un dominio de registro de Advantage, utilice la API POST. Esta es la columna URL de enlace heredada que se bloqueó anteriormente por la limitación de coincidencia de dominio exacta, tenga en cuenta que se necesita https://. Esta API se puede ejecutar varias veces para agregarla a la lista existente.
POST/d2l/api/le/{version}/ltiadvantage/registration/{clientId}/legacydomains/
Figura: Utilice la API POST para asignar la URL del enlace heredado a un dominio de registro de Advantage.
5. Para asignar más de una URL de enlace heredado a un registro 1.3, utilice la API PUT. La API PUT reemplaza la lista existente de direcciones URL asignadas.
PUT/d2l/api/le/{versión}/ltiadvantage/registration/{clientId}/legacydomains/
Figura: Utilice la API PUT para asignar varias URL de enlace heredadas a un registro 1.3.
Todos los eventos de migración futuros ahora intentan una migración desde las URL de enlace heredadas asignadas al registro de dominio 1.3. La migración puede iniciarse mediante la API, la copia del curso, la importación o manualmente a nivel del curso.
La URL del enlace etiquetada después de la migración tiene la ruta de la URL del enlace heredado.
Los trabajos de migración fallidos se identifican en la tabla de registro de migración con entradas en el archivo No hay coincidencia de dominio columna.
Figura: El No hay coincidencia de dominio indica si se han producido errores en el trabajo de migración debido a problemas de coincidencia.
Cómo detener la API de mapeo de dominios de migración
Para detener este proceso, solicite la API PUT con una cadena vacía, esto eliminará los dominios heredados asignados anteriormente.
Para detener inmediatamente el proceso de migración, deshabilite el Migración automática de enlaces Alternar en la implementación o quitar las reglas de uso compartido en las que no se desee la migración. La integración también se puede deshabilitar en cualquier momento, pero esto también impide que toda la integración funcione, en lugar de solo la migración.
