Documentación de API
- 25 Oct 2022
- 1 Minuto para leer
Documentación de API
- Actualizado en 25 Oct 2022
- 1 Minuto para leer
Al trabajar con la API externa en Totara, es posible que desees ver una guía de referencia de la API, que describe todos los servicios disponibles en la API y cómo usarlos. Totara tiene documentación de referencia incorporada generada a partir del esquema GraphQL. Esta documentación reflejará las características de API disponibles para la versión específica de Totara que el sitio está ejecutando, e incluirá servicios agregados o modificados por personalizaciones de código de terceros.
Ten en cuenta que la documentación de la API reflejará la versión oficial de Totara que está utilizando el sitio. Si haces personalizaciones de código y deseas que sus servicios de API aparezcan en la documentación de la API, deberás reconstruirla para que esos cambios se reflejen en esta página. Si la documentación actual está desactualizada, la página de documentación de la API mostrará una advertencia que indica esto.
Solo los usuarios con la capacidad de documentación de totara/api:view pueden acceder a la documentación de API. Por defecto, esto incluye administradores de sitios, administradores de sitios y administradores de dominio de inquilinos.
Para ver la documentación, siga estos pasos:
- Navegar al menú de acceso rápido > Desarrollo API API > > documentación.
- Usa la tabla de contenido de la columna de la izquierda para saltar a una sección específica.
- Haga clic en Volver a API para volver a la lista de clientes de API.
En esta página puedes ver la siguiente información sobre la API:
- Detalles del criterio de valoración
- Autenticación
- Formato de solicitud
- Enlace al esquema de API
- Consultas y mutaciones disponibles
- Tipos disponibles
La página de documentación incluye ejemplos del formato de la solicitud específica y la respuesta que se devolverá desde la API.
© Copyright 2022 Totara Learning Solutions. All rights reserved.
¿Te ha sido útil este artículo?