Presentación

El navegador de API de Docebo está disponible dentro de su plataforma.

• Contiene documentación de referencia para todos los extremos disponibles públicamente de Docebo. Esta documentación se actualiza constantemente con la versión de API más reciente.
• También es interactivo, lo que significa que puede probar las llamadas a la API en los datos de su plataforma directamente desde el navegador de API.

Este artículo explica cómo acceder al navegador de API de su plataforma, autenticarse y empezar a trabajar con los distintos extremos.

Acceso al navegador de API

El enlace de acceso a la documentación de referencia de la API se obtiene añadiendo /api-browser a la URL de su plataforma. Por ejemplo:

https://.docebosaas.com/api-browser/

o

https:///api-browser/

Los microservicios disponibles aparecen enumerados en el cuadro combinado SERVICES. Cuando seleccione un nuevo microservicio, se cargará automáticamente su documentación específica.

Consejo: Para más información sobre los distintos microservicios y extremos, consulte el artículo Vista general de servicios y extremos de API.

Ver la documentación de referencia para un extremo

En el panel de navegación a la izquierda:

1. Seleccione el microservicio deseado desde la lista SERVICES (por ejemplo, Course) para cargar su documentación.
2. A continuación, en API REFERENCE, haga clic en una de las agrupaciones de ese servicio (por ejemplo, Categories) para expandir la lista de sus extremos.
3. Por último, haga clic en un extremo específico para pasar a su documentación.

Para el extremo seleccionado, verá en el panel derecho un Ejemplo de respuesta (Response sample) así como, si procede, un Ejemplo de texto (Body sample). Puede hacer clic en los encabezados Body schema (Esquema de texto) o Response schema (Esquema de respuesta) para expandir la documentación detallada de todos los parámetros.

En el panel central hay un área donde puede probar de forma interactiva el extremo probando una llamada en los datos de su plataforma. Sin embargo, para hacer esto primero debe obtener un token tal y como se describe en el siguiente apartado.

Obtener un token de acceso a la API

Para realizar llamadas desde el navegador de API, necesitará como Superadministrador, Usuario avanzado o usuario normal un token de acceso OAuth2 vinculado a sus credenciales de la plataforma.

A tener en cuenta: Docebo aprovecha los alcances y concesiones de OAuth para permitir el acceso a la API, por lo que los extremos siguen de forma predeterminada un modelo de acceso basado en el rol. Los permisos que tenga en la plataforma determinarán los recursos y las acciones a los que podrá acceder mediante llamadas a la API utilizando este token de acceso.

Comience iniciando sesión en su plataforma. También puede optar por no iniciar sesión en este momento, en cuyo caso deberá introducir sus credenciales de la plataforma más adelante.

1. Acceda ahora a la página del navegador de API y haga clic en el botón OAuth del panel central para el extremo que desee.
   
2. En el cuadro de diálogo que se abrirá, haga clic en Authorize (Autorizar) (no es necesario hacer clic en el alcance de la api).
   
3. Ahora, en el cuadro de diálogo Autorización necesaria, se le dará la bienvenida como el usuario como el que iniciara sesión con anterioridad: aquí, vuelva a hacer clic en Autorizar.
   
   Nota: Si no ha iniciado sesión con anterioridad en la plataforma, se le instará a que introduzca sus credenciales antes de poder hacer clic en Autorizar.
   
4. Ahora se le redirigirá de nuevo a la página del navegador de API, donde puede ver que ha iniciado sesión (el botón OAuth rezará ahora Signout (Cerrar sesión)):
   
   Ahora también está rellenado el campo Token:
   

Ya puede empezar a realizar llamadas a la API sobre los datos de su plataforma.

Nota: En el campo Token también puede pegar directamente un token de acceso OAuth2 generado previamente

Probar un extremo en el navegador de API

Una vez que haya proporcionado un token de acceso en el navegador de API, puede probar las llamadas a los extremos. Para ello, en el panel de navegación del navegador de API, seleccione el extremo igual que antes y, en el panel central, haga clic en el botón Try (Probar).

Se abrirá una ventana en la que podrá examinar la respuesta real de su plataforma a esta llamada a la API:

Precaución: Las llamadas a la API que realice aquí operarán sobre los datos reales de su plataforma, por lo que debe tener cuidado a la hora de realizar llamadas (DELETE, POST, etc.) que puedan modificar o eliminar datos.

Siguientes pasos

Para seguir aprendiendo acerca de cómo usar su navegador de API, incluyendo cómo manejar las llamadas que requieran parámetros, pase al artículo Envío de sus primeras solicitudes con el navegador de API.