Saltar al contenido principal

Resumen

La vista de Endpoints en el Docs explorer es la referencia navegable de cada endpoint que construiste en el APIs Playground. Para cada uno muestra la forma del request — método, URL y parámetros — más un cURL listo para ejecutar y un spec OpenAPI. Es la documentación de cliente HTTP que le pasas a un desarrollador para que llame tus endpoints desde sus propias herramientas (Postman, código, …). Para el modelo mental, consulta Conceptos básicos.
Endpoints (Docs explorer) vs. APIs Playground. Los endpoints se construyen y configuran en el APIs Playground. Esta vista es la referencia de solo lectura para llamarlos.

Dónde encontrarlo

La vista de Endpoints está en Docs explorer → Endpoints. El panel izquierdo lista cada endpoint, buscable, agrupado por módulo, y luego por tipo (por ejemplo Orchestration → Event), con el método HTTP de cada endpoint (GET, POST, …) al lado. Un selector de OpenAPI te deja ver o descargar el spec OpenAPI de todos tus endpoints — listo para Swagger o clientes externos.

Detalle del endpoint

Seleccionar un endpoint muestra su referencia:
CampoQué muestra
ModuleEl módulo de CXF al que pertenece el endpoint (p. ej. Orchestration).
TypeLa library/tipo del endpoint (p. ej. Event).
StatusSi está Enabled.
Método + URLEl método HTTP y la URL completa — …/api/v1/endpoints/{slug}.
ParametersLos parámetros expuestos — los que pasa quien llama — cada uno con su descripción.
Created / Last updatedTimestamps.

Probarlo

Un panel de Test configuration te deja llamar al endpoint sin salir de CXF:
  • Llena los parámetros del endpoint.
  • Elige una API Key — solo se listan las keys habilitadas.
  • Ejecútalo y copia el cURL generado, que envía el request con un header Api-Key (y un body JSON para métodos de escritura).

Gobernanza y permisos

Solo un super admin o un Master puede ver y probar endpoints aquí. La vista es de solo lectura — los endpoints se editan en el APIs Playground.

Acceso por API

Los endpoints se llaman en …/api/v1/endpoints/{slug} con un header Api-Key. Consulta la API reference.

Relacionado

APIs Playground

Construye y configura los endpoints listados aquí.

Bundles

Agrega varios endpoints en una sola llamada.

API Keys

Las keys usadas para llamar un endpoint.