Presentación

El navegador de API de Docebo es una interfaz que le ayuda a explorar los extremos de API disponibles en su plataforma e interactuar con ellos. Esta guía le enseña a utilizar el navegador de API para verificar si hay una API para una acción concreta, como crear usuarios, exportar informes o gestionar contenidos de aprendizaje. En el navegador de API, puede ver todos los servicios y sus extremos relacionados, comprobar qué operaciones se admiten, qué parámetros se necesitan y cómo utilizar cada extremo para llevar a cabo tareas a lo largo de su plataforma.

Para obtener instrucciones sobre cómo acceder al navegador de API y autenticarse, consulte el artículo Primeros pasos con el navegador de API de Docebo.

Recuerde: Cuando utilice el navegador de API, todas las acciones que lleve a cabo serán reales y afectarán directamente a su plataforma. No son solo pruebas, por lo que debe tener cuidado a la hora de ejecutar operaciones.

Introducción a los servicios y extremos

En el navegador de API, las acciones se agrupan en servicios. Un servicio representa una funcionalidad parcial de la plataforma, como la gestión de usuarios, la gestión de transacciones o el tratamiento de datos.

Cada servicio tiene extremos, que son URL específicas que se utilizan para llevar a cabo acciones. Por ejemplo, si selecciona el servicio manage (gestionar), al expandir la agrupación Users (Usuarios) encontrará extremos como:

• GET /manage/v1/users: Recupera una lista de usuarios
• POST /manage/v1/users: Crea un nuevo usuario

De manera similar, si selecciona el servicio learn (aprender), al expandir la agrupación Catalogue (Catálogo) encontrará, entre otros extremos:

• GET /learn/v1/catalog/filters: Recupera todas las opciones de filtros para un catálogo

El navegador de API le guiará a la hora de utilizar estos servicios, mostrándole qué información (parámetros) debe proporcionar, cómo dar formato a sus solicitudes y qué tipo de respuestas esperar. También incluirá detalles de autenticación y ejemplos que le ayudarán a utilizar la API con eficacia.

Referencia rápida de los servicios del navegador de API

La siguiente tabla ofrece una visión general de dónde pueden encontrarse distintas funcionalidades dentro de cada servicio de la API. Este resumen le ayuda a encontrar rápidamente el servicio adecuado y los extremos asociados tomando como base la funcionalidad que necesite. Tenga en cuenta que algunas funciones pueden estar cubiertas por más de un servicio.

Learn

Este servicio abarca acciones de aprendizaje tanto formales como informales en la plataforma, incluyendo:

• Cursos y sesiones de e-learning y vILT, así como formación externa
• Gestión de las inscripciones para cursos y planes de aprendizaje
• Gestión de canales y activos
• Materiales de formación y activos, como encuestas, exámenes, foros y repositorios de archivos de cursos
• Paquetes de suscripción

Skill

Los extremos para la gestión de las habilidades de los usuarios en la plataforma:

• Asociaciones de habilidades a usuarios, cursos y perfiles
• Extremos de las funciones de superiores y Mi equipo
• API de integración para sistemas externos de gestión de talentos

Share

Se encarga de la gestión del aprendizaje informal, incluyendo:

• Activos, canales, preguntas y respuestas y expertos de Coach & Share
• Funciones de gamificación

Manage

Abarca las funciones de gestión general de la plataforma, como:

• Gestión de usuarios, repositorio central, reglas de inscripción, tareas en segundo plano y aplicación móvil
• Extended enterprise (multidominio), **estructura de ramas, configuraciones de marca
• Búsqueda global, política de cookies, privacidad y términos y condiciones

Notifications

Contiene extremos relacionados con:

• Notificaciones y configuración DKIM**

E-commerce

Incluye:

• Extremos para transacciones, información de facturación y configuraciones de comercio electrónico

Marketplace

Los extremos de este servicio se ocupan de:

• Proveedores de contenidos del mercado (GO1, LinkedIn Learning y OpenSesame). Los extremos disponibles varían en función del proveedor de contenidos.

Report

Los extremos se centran en:

• Datos del panel de control y recuperación de informes personalizados (informes antiguos)
• Informes de generadores de consultas

Pages

Incluye extremos para:

• Gestión de páginas y menús (creación, edición, eliminación)

OTJ

Se encarga de:

• Listas de comprobación de observación (gestión, subida, aprobación o rechazo)

Audittrail

Incluye:

• Extremos para consultas y protocolos del registro de auditoría

Course

Los extremos del servicio de cursos se encargan de:

• Cursos de e-learning, eventos de cursos ILT, sesiones y gestión de miniaturas

Analytics

Abarca:

• Generador de consultas, nuevos informes personalizados, paneles de control de informes e informes de superiores

Audiences

Incluye:

• Extremos para la gestión de grupos y usuarios

Poweruser

Incluye:

• Extremos para los permisos, perfiles y asociaciones de recursos de los Usuarios avanzados

Learningplan

Abarca:

• Gestión de planes de aprendizaje y configuraciones de inscripciones en planes de aprendizaje

Enrollment

• Contiene extremos solo para las inscripciones archivadas

Certification

Se encarga de

• Extremos para certificaciones concedidas.

Servicios que actualmente no tienen extremos accionables en el navegador de API

• Impact
• Proctoring
• External
• Conference tool
• Messenger

Categorías obsoletas

• Webinar

En el microservicio Learn, la mayoría de los extremos de los seminarios web están obsoletos o han dejado de recibir soporte.

Uso de los extremos

Más abajo encontrará una descripción general sobre cómo identificar el extremo que necesita y comprender cómo utilizarlo.

Localizar el servicio y el extremo:

En el navegador de API, busque el servicio que contenga la acción que desee realizar (por ejemplo, gestión de usuarios, actualización de cursos). Seleccione el servicio deseado en la lista desplegable Services.

Una vez que esté en el servicio correcto, aún en el panel de la izquierda, desplácese hacia abajo para encontrar el extremo específico bajo el encabezado API Reference (en este ejemplo, Retrieves content of the given catalog o Recupera el contenido del catálogo indicado). Desde aquí podrá acceder a la URL de la API.

Ver los detalles del extremo:

Después de seleccionar el extremo, en el panel central verá los parámetros que ayudan a refinar su solicitud. Estos parámetros pueden incluir:

• Parámetros requeridos: Información que debe proporcionar para ejecutar correctamente el extremo.
• Filtros opcionales: Opciones para limitar los resultados (por ejemplo, filtrando por usuarios concretos).
• Tamaño de los resultados: Puede definir el número de resultados por página que desee.
• Opciones de clasificación: Elija cómo ordenar los resultados (por ejemplo, por fecha o nombre).

Rellenando los parámetros y configuraciones correctos, puede asegurarse de que el extremo funcione con fluidez y sin errores.

Ver la respuesta de ejemplo:

En el panel derecho del navegador de API, verá un ejemplo de la respuesta del extremo. Esta respuesta muestra el tipo de datos que recibirá cuando se efectúe una llamada al extremo correctamente. Algunos ejemplos de tipos de datos son:

• String: Una cadena o "string" es una recopilación de caracteres, como palabras o texto. Por ejemplo, "Hola mundo".
• Integer: Un número entero o "integer" es un número sin decimales. Por ejemplo, 25 o 100.

La respuesta de ejemplo le ayudará a comprender el formato de los datos que devolverá el extremo, para que sepa qué esperar cuando realice sus solicitudes a la API.

Comprobar el esquema de respuesta:

En el panel derecho, debajo del ejemplo de respuesta, encontrará el Response schema (Esquema de respuesta). En esta sección se proporciona una definición y una explicación detalladas de cada elemento incluido en la respuesta. Desglosa lo que significa cada campo de la respuesta y qué tipo de datos contiene (por ejemplo, string o integer).

Por ejemplo, si la respuesta incluye los detalles de un catálogo, es posible que el esquema explique:

• "id" (string): El ID del catálogo.
• "name" (string): El nombre del catálogo.
• "description" (string): La descripción del catálogo solicitado.

Esto le ayuda a comprender la estructura y el significado de los datos que devuelve el extremo.