Descargo de responsabilidad: Este artículo se generó mediante traducción automática.
Planes que respaldan la documentación API
| Profesional | Negocio | Empresa |
|---|---|---|
La función de documentación de API de Document360 proporciona una solución completa para crear y gestionar referencias de API. Esta función le permite generar documentación de API de alta calidad que ayuda a los usuarios a comprender y trabajar con sus API de manera efectiva. Puede generar esta documentación cargando el archivo de especificación de API desde una dirección URL, un archivo JSON/YAML o mediante la integración con un flujo de CI/CD.
Además, la función ¡Pruébelo! de Document360 le permite probar los puntos finales de la API directamente en el Knowledge base site. La consola interactiva en el sitio de la base de conocimientos permite a los desarrolladores ingresar los parámetros necesarios y ejecutar llamadas a la API, obteniendo respuestas en tiempo real. Esta característica es útil para solucionar problemas y comprender cómo se comporta una API sin salir de la documentación ni escribir ningún código.
Técnicas de autorización
Al interactuar con una API, es importante asegurarse de que solo los usuarios autorizados puedan acceder a ciertos datos o realizar acciones específicas. Esto se hace mediante técnicas de autorización, que controlan el acceso y los permisos. Document360 admite varios métodos de autorización para proteger su API, entre los que se incluyen:
Autenticación básica: Requiere un nombre de usuario y una contraseña pasados en la solicitud.
Token al portador: UAuthenticate con un token generado después del inicio de sesión.
Clave de API: utiliza una clave única, que se pasa en los encabezados de la solicitud, para la autenticación.
OAuth2: protege las API a través de varios flujos, como código de autorización, PKCE, credenciales de cliente y flujos implícitos.
OpenID Connect: amplía OAuth2 al agregar la verificación de identidad del usuario.
Consideraciones de autorización (OAuth2 y OpenID)
Al trabajar con API que usan OAuth2 u OpenID para la autorización, ciertas configuraciones son esenciales para una funcionalidad adecuada.
URI de redireccionamiento: esta es la URL a la que se redirigirá al usuario después de completar un flujo de autorización. Asegúrese de establecer el URI en el formato:
domain/oauth. Por ejemplo:https://apidocs.document360.com/oauth.Renovación silenciosa: la renovación silenciosa actualiza automáticamente el token de autorización en segundo plano, para que los usuarios no tengan que volver a autenticarse durante su sesión. Esto mantiene su sesión activa sin interrupción. Para evitar que la autorización caduque durante las sesiones en las que los usuarios interactúan con la función ¡Pruébelo! , Document360 renueva automáticamente el token de actualización en segundo plano. Esto garantiza que los usuarios no tengan que volver a autenticarse manualmente.
Adquisitivo
Tendrá acceso a 1 espacio de trabajo de API como parte de todos los planes de pago de Document360 (Professional, Business y Enterprise). Si desea comprar espacios de trabajo de API adicionales,
Vaya a Configuración > portal de la base de conocimientos > Facturación > Mi plan.
Haz clic en Comprar complemento.
Agregue el número deseado de espacios de trabajo de documentación de API. Revise el costo del complemento y el monto adeudado.
Haga clic en Confirmar pago para continuar con el pago.
Preguntas frecuentes
¿Qué es una referencia de API?
Una referencia de API es un recurso de documentación que proporciona información completa sobre las funciones, las clases, los métodos, los parámetros, los tipos de valor devuelto y otros componentes de una API. Es una guía o manual para desarrolladores que quieran integrar o utilizar la API en sus aplicaciones.
¿Cuántas referencias de API puedo crear con la documentación de la API de Document360?
Dentro de cada espacio de trabajo de API, podrás crear un máximo de 3 referencias de API.
La opción "¡Pruébalo!" no está disponible en el sitio de la base de conocimientos. ¿Cuál podría ser la razón?
Si la característica ¡Pruébalo! no está visible en el sitio de la base de conocimientos, asegúrese de que tanto la variable de servidor como la URL estén definidas correctamente en el archivo de especificaciones de la API. Sin estos, la función no funcionará.
¿Cuáles son los formatos de archivo de especificación compatibles?
Puede cargar el archivo de especificaciones como un archivo URL, JSON o YAML . Document360 es compatible con las especificaciones OpenAPI 2.0, OpenAPI 3.0 y Postman API.
Videos relacionados
Experimente nuestra moderna documentación de API en Document360 como nunca antes
Pruebe los puntos de conexión de la API directamente desde la documentación con la función Pruébelo
Información adicional
Presentación de la documentación de la API: Mejore su experiencia con la API - Haga clic para leer