Presentación

Este artículo proporciona una guía detallada sobre cómo realizar diferentes tipos de solicitudes de API utilizando el navegador de API de Docebo, incluyendo llamadas con parámetros obligatorios y aquellas que requieren parámetros en el cuerpo.
Para obtener una visión general sobre la navegación por los distintos servicios y extremos una vez dentro del navegador de API, consulte el artículo Descripción general de los servicios y extremos de API.

Autenticación

Antes de comenzar a realizar llamadas a la API, deberá acceder al navegador de API a través de https://<URL de su plataforma>/api-browser/ y autenticarse. Este proceso se explica con mayor detalle en el artículo Primeros pasos con el navegador de API de Docebo.

Existen dos métodos principales para autenticarse:

Método 1: Inicie sesión primero en la plataforma y luego abra el navegador de API en otra pestaña. Este método es recomendable si utiliza un inicio de sesión único o SSO.

Método 2: Otra opción para la autenticación consiste en introducir sus credenciales directamente en el navegador de API.

Una vez autenticado, el botón Oauth en el navegador de API cambiará a Cerrar sesión.

Antes de la autenticación	Autenticación realizada correctamente

A tener en cuenta: Independientemente del método de autenticación empleado, las acciones disponibles a través del navegador de API estarán limitadas por los permisos asignados a su cuenta en la plataforma. Si posee el rol de Usuario Avanzado, es posible que no pueda realizar determinadas llamadas o acceder a determinados recursos.

API sin parámetros obligatorios

Algunas API no requieren parámetros para su ejecución. Para probar su primera llamada a la API, lo más fácil es seleccionar una que no requiera parámetros. Además, se sugiere optar por una llamada GET, ya que estas solo recuperan datos, evitando así posibles modificaciones no deseadas. Aquí le mostramos un ejemplo de cómo hacerlo:

Comprobación de si se requieren parámetros:

Una vez identificado el servicio y el extremo, puede verificar si se requieren parámetros. Si los campos en blanco no presentan el marcador “required” (obligatorio), la API puede ejecutarse sin necesidad de introducir datos.

En este ejemplo, utilizaremos el extremo de la API para obtener información sobre todos los cursos, Devolver todos los cursos: get/learn/v1/courses.

Ejecución del extremo:

Una vez autenticado, puede desplazarse debajo de los parámetros y, en Probar este extremo, hacer clic en el botón PROBAR. La respuesta se mostrará conforme al esquema en el formato JSON predeterminado. 

API con parámetros obligatorios

En este segundo ejemplo, analizaremos un extremo de API con un parámetro obligatorio. Para que el extremo funcione correctamente, deberá incluirse dicho parámetro en la solicitud para obtener la respuesta esperada. 

Identificación de los parámetros obligatorios:

Cuando un parámetro sea obligatorio, la documentación del navegador de API lo indicará mediante un marcador, como se muestra a continuación.

En este ejemplo, utilizaremos el extremo de API para obtener información sobre un curso específico, Ver un curso: get/learn/v1/courses/{course_id}. 

En el navegador de API se observa que es necesario introducir un valor numérico, el course_id. 

Obtención del valor del parámetro obligatorio: 

Para encontrar el parámetro obligatorio, puede resultar útil consultar una segunda API o las URL de la plataforma.

En este ejemplo, se requiere el ID del curso. Este puede obtenerse de dos maneras:

• El ID del curso puede localizarse directamente en la plataforma. Si ya conoce el nombre del curso, búsquelo en la plataforma y extraiga el ID desde la URL.
• Si necesita recuperar múltiples ID a la vez, puede utilizar una segunda API. En este caso, es posible aprovechar la API del ejemplo anterior (Devolver todos los cursos: get/learn/v1/courses). La respuesta al extremo Devolver todos los cursos mostrará el ID del curso.

Consejo: Los informes también pueden ayudar a obtener ID de cursos y usuarios. Para más información sobre la recuperación de ID, consulte el artículo sobre recuperación de ID. Para obtener detalles adicionales sobre cómo recuperar ID directamente desde la interfaz de la plataforma Docebo, puede resultar útil este artículo de la Comunidad (se abre en una nueva pestaña).

Ejecución del extremo:

Una vez autenticado y, tras introducir los parámetros obligatorios, puede hacer clic en el botón PROBAR. La respuesta se mostrará conforme al esquema en el formato JSON predeterminado.

API con parámetro en el cuerpo

En el navegador de API, algunos extremos requieren que se incluya un cuerpo en la solicitud. El cuerpo es el espacio donde se proporcionan los datos que se enviarán al servidor, por ejemplo, para crear o actualizar información. A continuación se presenta una guía rápida para probar un extremo que requiera un cuerpo en el navegador de API.

Copia del cuerpo de ejemplo:

Para facilitar la introducción de un parámetro en el cuerpo, puede utilizar el cuerpo de ejemplo mostrado en el lado derecho de la pantalla. Al hacer clic en él, el ejemplo se copiará automáticamente en el campo de texto del cuerpo.

Edición del cuerpo:

Una vez añadido el cuerpo de ejemplo, deberá reemplazar los valores de los marcadores (textos entre comillas situados a la derecha de cada par key:value) con sus propios datos. Por ejemplo, si el ejemplo muestra "name": "string", deberá sustituir "string" por el nombre real que desee introducir.

→ Si el cuadro destinado al cuerpo es demasiado pequeño, puede ampliarlo haciendo clic y arrastrando la esquina.

Comprensión de los datos a introducir:

Si no tiene claro qué datos debe incluir, revise la sección del esquema del cuerpo. Esta indica los tipos de valores esperados (por ejemplo, cadena, número) y señala qué campos son obligatorios para que la solicitud tenga éxito.

Ejecución del extremo:

Una vez rellenados todos los valores requeridos en el cuerpo, autentíquese según sea necesario y estará listo para ejecutar el extremo. Esto enviará su solicitud al servidor con los datos proporcionados.