Navegar la referencia REST
Organiza la documentación por recurso y muestra las operaciones disponibles con su método HTTP.
Que se logra
- Resultado: un integrador identifica qué operaciones REST usar para conectar recursos de Apex.
- Caso de uso: un sistema de reservas consulta la referencia para sincronizar servicios o disponibilidad.
- Se combina con: autenticación, códigos de error y conexiones MCP.
Donde esta
- Ruta:
/docs/api-reference. - Acceso en UI:
Docs > API Reference. - Componente(s):
sidebar.tsx.
Como funciona
- Abrir una categoría de recurso en la barra lateral.
- Elegir la vista general o una operación.
- Revisar el método mostrado como
GET,POST,PATCHoDELETE.
Reglas y validaciones
- La navegación incluye recursos como contactos, compañías, conversaciones, deals, productos, reservas, asistentes y organizaciones.
Backend
- Servicios: las rutas REST documentadas por cada página.
Relaciones
- Requiere: autenticación cuando la operación lo exige.
- Dispara / afecta: integración por API externa.
Notas
- La estructura de navegación está definida estáticamente en la barra lateral.