Presentación

Este artículo proporciona orientación adicional sobre el uso de determinados extremos con el navegador de API, junto con limitaciones importantes a tener en cuenta. 
Para una introducción sobre cómo utilizar el navegador de API, consulte el artículo Primeros pasos con el navegador de API de Docebo.

Navegador de API y campos adicionales

Los campos adicionales utilizados en la plataforma para la gestión de usuarios, cursos e inscripciones son gestionados por los Superadministradores como valores dinámicos y no se pueden incluir en la documentación del navegador de API, ya que varían según la plataforma. Por la misma razón, no es posible probar campos adicionales desde el navegador de API. Por ejemplo, si desea filtrar cursos según el valor de un campo adicional del curso donde xx sea el ID del campo adicional (como field_1, field_2, etc.), la secuencia a utilizar sería similar a:

https://yourdomain.docebosaas.com/learn/v1/enrollments?field_6=3

El ID que deberá utilizar en su consulta en lugar de xx será bien un valor entero (por ejemplo, para los campos adicionales desplegables), una secuencia (para un campo adicional de texto), una matriz o una fecha (para campos adicionales de fecha). Aquí le presentamos algunos ejemplos:

date:

'field_12': {'from': '2018-06-26','to': '2018-06-30'},

textfield:

'field_6': 'abc'

O
 

'field_6': ['abc', 'def'], dropdown: 'field_8': 3

campos adicionales iframe:

Extienda field_xx y field_xx_yy donde yy sea el campo de la configuración JSON y utilice esta sintaxis: '$^speakers^speaker'. El valor será bien una secuencia (para un campo adicional de texto) o una matriz o fecha (para campos adicionales de fecha). Ejemplos:

date:

'field_12$^datefield': {'from': '2018-06-26','to': '2018-06-30'},

textfield:

'field6$^textfield': 'abc'

O
 

'field6$^textfield': ['abc', 'def']

Atributos JSON generados dinámicamente

Tenga en cuenta que, en casos excepcionales, los atributos generados dinámicamente en los datos JSON no pueden representarse correctamente en la interfaz de usuario de la documentación de referencia. Esto podría impedirle probar la API directamente desde la documentación en sí. En este caso, le sugerimos utilizar una herramienta especial (por ejemplo, Postman).

Extremos para la descarga de archivos 

El navegador de API no se puede utilizar para probar llamadas a extremos que descargan archivos, como: 

Download the course file content: 
GET /learn/v1/filerepo/downloadCourseFile 

Generate PDF file that includes charts for privacy policy:  
POST /report/v1/privacy_policy/pdf   

Download course enrollment statistics PDF file: 
POST /learn/v1/courses/enrollment_pdf

GET exported report file stream: /analytics/v1/reports/{id_report}/exports/{id_export}/download

Cuando se llama desde la interfaz del navegador de API, tales extremos no devolverán una respuesta ni descargarán ningún archivo. Para probarlos, utilice Postman u otras herramientas similares.

Manejo de campos de matriz para solicitudes GET

Los parámetros de la secuencia de consulta, descritos como matrices, deben especificarse de forma diferente en función de la herramienta que utilice para consumir la API:

• Navegador de API de Docebo: debido a conversiones internas aplicadas por esta herramienta, los parámetros deben estar separados por una coma. Además, si los parámetros son secuencias, deben ir entre comillas dobles. Ejemplo:

  "enrollment_status", "enrollment_completion_percentage”

• Postman (o clientes similares): el parámetro debe ir seguido de dobles corchetes y especificarse tantas veces como valores necesite pasar. Ejemplo:

  <ENDPOINT>?learning_plan_id[]=25&learning_plan_id[]=1&extra_fields[]=enrollment_time_spent&extra_fields[]=enrollment_status