Presentación
La mayoría de los elementos de la plataforma que pueden crearse, editarse o eliminarse tienen un ID único. Este ID es esencial para realizar acciones de API sobre ellos. Por ejemplo, si desea ver los datos de un curso utilizando el extremo de API GET /learn/v1/courses/{course_id}, necesitará el ID del curso para realizar la solicitud.
Este artículo explica cómo recuperar ID únicos, como ID de usuarios, de cursos y de catálogos, que son necesarios para realizar acciones de API y acceder a datos. Proporciona métodos y ejemplos de cómo obtener estos ID a través de extremos de API, utilizando el navegador de API.
Recuperar ID directamente desde la plataforma
Los ID más comunes que utilizan los administradores de la plataforma son los ID de usuarios y los ID de cursos. Estos pueden recuperarse directamente desde la plataforma.
- ID de usuarios: Puede encontrarlos generando un informe personalizado de Usuarios.
- ID de cursos: Puede obtenerlos mediante una exportación de los datos del curso en formato CSV o XLS desde la página de gestión de cursos.
Para más detalles sobre cómo recuperar ID directamente desde la interfaz de la plataforma Docebo, puede resultar útil este artículo de la Comunidad sobre cómo encontrar ID únicos (se abre en una nueva pestaña).
En el siguiente capítulo veremos cómo, a través de API, podemos recuperar ID no solo para usuarios y cursos, sino también para catálogos, planes de aprendizaje y notificaciones, entre otras cosas.
Recuperar ID mediante el navegador de API
Cuando no se pueden recuperar ID a través de la interfaz de la plataforma, pueden servir de ayuda algunos extremos de API GET. Aquí se explica cómo hacerlo:
Verificar la muestra de la respuesta
Antes de lanzar el extremo, revise la muestra de la respuesta para asegurarse de que incluye el ID que necesita. La muestra indica qué datos devolverá la API.
Lanzar el extremo
Después de verificar que el extremo proporciona el ID necesario, como un ID de curso, puede lanzar la API correspondiente (por ejemplo, GET/learn/v1/courses). Recuerde autenticarse como se describe en el artículo Primeros pasos con el navegador de API de Docebo.
Recuperar ID de catálogos
Para recuperar ID de catálogos, puede seguir un enfoque similar, pero teniendo en cuenta algunas diferencias con otros extremos.
Encontrar el extremo y validar el esquema de respuesta
Como se ha explicado anteriormente, revisar el esquema de respuesta ayuda a determinar si el extremo devuelve el ID que busca. Normalmente, el ID aparece al principio de la respuesta. Sin embargo, para los ID de catálogos, generalmente se encuentra hacia el final de cada elemento de la respuesta. La siguiente tabla destaca esta diferencia:
| Devuelve todos los cursos | Recupera parte del contenido para todos los catálogos indicados |
Lanzar el extremo de catálogo
Recuerde: Al usar la API, la lista devuelta del contenido del catálogo depende de la configuración del curso y las reglas de visibilidad del catálogo para el usuario que realiza la solicitud. Si un catálogo no es visible o no ha sido asociado con el usuario solicitante, no aparecerá en los resultados.
Para recuperar información de los catálogos dentro de este alcance, utilice el extremo:
- GET/learn/v1/catalog_content/internal/preview
Limitar los resultados
Al usar la API para recuperar ID de catálogos, puede limitar el número de resultados a solo uno para acceder rápidamente al ID del curso. Esto hace que sea más fácil encontrar la información que necesita. Tenga en cuenta que solo se devolverán catálogos con cursos o planes de aprendizaje asociados.
Autenticarse y lanzar el extremo
Autentíquese como se describe en el artículo Primeros pasos con el navegador de API de Docebo. A continuación, use el botón Intentar para enviar su solicitud.
Identificar el ID del catálogo en la respuesta
Una vez mostrada la respuesta, identifique el ID del catálogo. Busque el campo extra_data, donde se mostrará el entero del ID del catálogo:
Ejemplo: Usar un ID de catálogo para recuperar información de un catálogo dado
Para recuperar detalles sobre un catálogo específico, use el siguiente extremo:
- GET/learn/v1/catalog_content/internal/{catalog_id}.
Esto proporcionará todo el contenido vinculado a ese catálogo.
Identificar el extremo y sus requisitos
Extremo: get/learn/v1/catalog_content/internal/{catalog_id}
Requisitos: catalog_id es un parámetro obligatorio
Recuperar el ID del catálogo
Use el extremo GET/learn/v1/catalog_content/internal/preview para obtener el ID del catálogo, como se describió en el capítulo anterior.
Una vez que tenga el ID del catálogo deseado, puede introducirlo como parámetro para el extremo get/learn/v1/catalog_content/internal/{catalog_id}
Autenticarse y lanzar el extremo
Después de autenticarse, puede hacer clic en Intentar para lanzar el extremo.
Los resultados incluirán el número total de cursos en el catálogo e información detallada para cada curso. La estructura de la respuesta es fija y no puede personalizarse.
Siguiendo estos pasos, puede recuperar y usar eficientemente los ID dentro de la plataforma para interactuar con sus diversos componentes mediante API.
Lista de API para la recuperación de ID
En los capítulos anteriores ha visto algunos ejemplos de cómo utilizar API para recuperar ID de objetos en la plataforma. Ahora puede intentar aplicar un patrón similar para recuperar otros ID.
Las siguientes tablas proporcionan algunas sugerencias de extremos que puede utilizar para recuperar ID de uso común en la plataforma. Las listas están organizadas por servicios, pero tenga en cuenta que a veces puede recuperar ID de un objeto particular desde más de un servicio. Como se explicó en los ejemplos anteriores, después de realizar una llamada, use el esquema en el navegador de API para determinar dónde se puede encontrar el ID en la respuesta.
Tenga en cuenta que esta no es una lista exhaustiva de todas las formas en que puede recuperar ID, sino solo una selección de extremos útiles. Además, recuerde que las reglas de visibilidad se aplican a las respuestas de estos extremos, por lo que los objetos incluidos en las respuestas dependerán de los permisos y asignaciones de recursos del usuario que realiza la llamada. En particular:
→ Para los Usuarios avanzados, su visibilidad sobre los objetos depende de sus permisos y asignaciones de recursos
→ Además, algunos extremos pueden no devolver todos los objetos. Por ejemplo, los usuarios (incluso los Superadministradores) solo tienen visibilidad sobre los catálogos a los que están asignados.
Servicio - Aprendizaje
| Para recuperar ID de: | Extremo | Notas |
| Cursos | get/learn/v1/courses | |
| Catálogos | get/learn/v1/catalog_content/internal/preview |
Parámetro cursor requerido (use el valor predeterminado 0)
El ID del catálogo está en el campo extra_data.
Solo se incluyen catálogos asignados al usuario en la respuesta |
| Categorías | get/learn/v1/categories | |
| Certificaciones | get/learn/v1/certification | |
| Aulas | get/learn/v1/classroom | |
| Sesiones | get/learn/v1/courses/{course_id}/sessions/enrollments | parámetro course_id requerido |
| Campos adicionales de cursos | get/learn/v1/courses/field | |
| Materiales de formación | get/learn/v1/courses/{course_id}/los | |
| Formación externa | get/learn/v1/external_training | |
| Envío de asignaciones | get/learn/v1/instructor/assignment | |
| Ubicación del aula | get/learn/v1/location | También es visible en la interfaz de la plataforma |
| Paquete de suscripción | get/learn/v1/sub_bundle | |
| Campos adicionales del paquete de suscripción | get/learn/v1/sub_field | |
| Planes de suscripción | get/learn/v1/sub_plan | |
| Registros de suscripción | get/learn/v1/sub_record | |
| Cuentas de herramientas de conferencias web vinculadas a la plataforma |
get/learn/v1/webinar/accounts (Zoom) get/learn/v1/webinar/adobeconnect/accounts get/learn/v1/webinar/gotomeeting/accounts get/learn/v1/webinar/bluejeans/accounts get/learn/v1/webinar/msteams/accounts |
Servicio - Administración
| Para recuperar ID de: | Extremo | Requisitos |
| Canales | get/manage/v1/channels | Solo se devuelven canales visibles para el usuario |
| Socios de contenido | get /manage/v1/contentpartners | |
| Reglas de inscripción heredadas | get/manage/v1/enrollment_rules | |
| Campo de inscripción | get/manage/v1/enrollment_fields | |
| Tipos de superiores | get/manage/v1/managers/types | |
| Dominios de Extended enterprise | get/manage/v1/multidomain | |
| Ramas | get/manage/v1/orgchart | |
| Políticas de privacidad | get/manage/v1/policy | |
| Etiquetas | get/manage/v1/tags | |
| Términos y condiciones | get/manage/v1/termsandconditions | |
| Usuarios | get/manage/v1/user | |
| Campos adicionales de usuarios | get/manage/v1/user_fields |
Servicio - Habilidades
| Para recuperar ID de: | Extremo | Notas |
| Lista de habilidades | get/skill/v1/skills/catalog | |
| Grupos de habilidades | get/skill/v1/skillgroups | |
| Lista de categorías de personal | get/skill/v1/workforce/categories |
Servicio - Compartir
| Para recuperar ID de: | Extremo | Notas |
| Canales | get/share/v1/admin/channels | |
| Recursos | get/share/v1/admin/assets | |
| Recursos por usuario | get/share/v1/assets | Se devuelven recursos asignados a canales visibles para el usuario |
| Expertos | get/share/v1/admin/assets | |
| Preguntas |
get/share/v1/questions get/share/v1/questions/list |
|
| Respuestas | get/share/v1/answers | |
| Comentarios | get/share/v1/comments | |
| Listas de reproducción | get/share/v1/playlists | Parámetro type_content requerido (‘asset’ o ‘my-course’) |
| Materiales de formación | get/share/v1/gamification/courses/{id_course}/los | Parámetro id_course requerido |
Servicio - Compartir (Gamificación)
| Para recuperar ID de: | Extremo | Notas |
| Insignias | get/share/v1/gamification/badges | |
| Colecciones de insignias | get/share/v1/gamification/collections | |
| Imágenes de insignias | get/share/v1/gamification/badges/images |
Servicio - Comercio electrónico
| Para recuperar ID de: | Extremo | Notas |
| Cupones | get/ecommerce/v1/coupon | |
| Transacciones |
get/ecommerce/v1/transaction
get/ecommerce/v1/transaction/list - (Nueva API) |
Servicio - Informes
| Para recuperar ID de: | Extremo | Notas |
| Registros de formación externa (Transcripción) | get/report/v1/mytranscript | |
| ID de informes del generador de consultas | get/report/v1/query_builder | |
| ID de informes heredados | get/report/v1/report |
Servicio - Páginas
| Para recuperar ID de: | Extremo | Notas |
| Menús | get/pages/v1/menus | |
| Páginas | get/pages/v1/pages |
Servicio - OTJ (Listas de comprobación de observación=
| Para recuperar ID de: | Extremo | Notas |
| Lista de comprobación | get/otj/v1/checklists | |
| Versión de la lista de comprobación | get/otj/v1/checklists/{checklist_id}/versions |
Servicio - Cursos
| Para recuperar ID de: | Extremo | Notas |
| Curso | get/course/v1/courses | |
| Sesión | get/course/v1/sessions/ilt | |
| Eventos por sesión | get/course/v1/sessions/{session_id}/events | Parámetro session_id requerido |
| Miniaturas | get/course/v1/thumbnails |
Servicio - Análisis
| Para recuperar ID de: | Extremo | Notas |
| ID de informes del generador de consultas | get/analytics/v1/custom-report-types/active | |
| ID de informes del generador de consultas | get/analytics/v1/custom-report-types | |
| Nuevos informes (sin heredados) | get/analytics/v1/reports |
Servicio - Audiencias
| Para recuperar ID de: | Extremo | Notas |
| ID de audiencia (Grupo) | get/audiences/v1/audience | |
| Obtener ID de grupo por ID de audiencia | get/audiences/v1/audience/{uuid}/audience_to_group | |
| Obtener ID de audiencia por ID de grupo | get/audiences/v1/audience/{id}/group_to_audience |
Servicio - Usuarios avanzados
| Para recuperar ID de: | Extremo | Notas |
| Usuarios avanzados | get/poweruser/v1/powerusers | |
| Perfiles de Usuarios avanzados | get/poweruser/v1/profile | |
| Usuarios avanzados según perfil | get/poweruser/v1/profiles/{profile_id}/poweruser | Parámetro profile_id requerido |
Servicio - Planes de aprendizaje
| Para recuperar ID de: | Extremo | Notas |
| Planes de aprendizaje | get/learningplan/v1/learningplans | |
| Campos adicionales de planes de aprendizaje | get/learningplans/2/additionalfields |
Servicio - Inscripciones
| Para recuperar ID de: | Extremo | Notas |
| IDs de registros de inscripciones archivadas | get/enrollment/v1/courses/{course_id}/archives | Parámetro course_id requerido |
| Lista de sesiones de inscripciones archivadas de cursos | get/enrollment/v1/courses/archives/{record_id}/sessions | record_id requerido |