Catálogo y documentación de APIs

Catálogo y documentación de APIs

Resumen

Al ingresar al portal para desarrolladores, la página de inicio muestra el Catálogo: un único listado con las APIs y los servidores MCP a los que usted tiene acceso. Desde el catálogo puede buscar por título, filtrar por categoría y por protocolo, y abrir la documentación de cada recurso.

Antes de comenzar

1. Recorrer el catálogo

El catálogo tiene dos pestañas:

  • Compartidas conmigo: los recursos privados a los que le dieron acceso.
  • Públicas: los recursos públicos de la organización.

Cada pestaña indica entre paréntesis cuántos recursos tiene. Cada recurso se muestra en una tarjeta con su ícono, su título y dos etiquetas: la categoría y el protocolo (REST, SOAP, WebSocket o MCP). Use Expandir para ver todas las tarjetas de la pestaña.

Catálogo del portal con filtros de búsqueda, categoría y protocolo

2. Buscar y filtrar

A la izquierda del catálogo hay tres bloques de filtros, que se pueden combinar entre sí:

  • Buscar: escriba parte del título en Filtrar por título....
  • Categoría: muestra solo los recursos de la categoría elegida.
  • Protocolo: muestra solo los recursos de ese protocolo. Aparecen solo los protocolos que tienen al menos un recurso en el catálogo.

Los filtros se aplican a las dos pestañas. Para volver a ver todo, haga clic en Quitar filtros.

Por ejemplo, si elige el protocolo MCP, el catálogo muestra solo los servidores MCP:

Catálogo filtrado por el protocolo MCP

3. Ver la documentación de una API

Haga clic en la tarjeta de una API para abrir su documentación. Si la API tiene varios entornos, elija el que necesita en Entorno.

  • Métodos: la lista de métodos de la versión. Solo verá el detalle de los métodos públicos y de los privados a los que le dieron acceso.
  • Exportar OpenAPI: con Descargar OpenAPI obtiene la especificación de todos los métodos de la versión a los que tiene acceso.
  • Detalles del método: ruta, tipo de contenido, protocolo, autenticación, permisos disponibles, parámetros, diccionarios de datos, SLO y límites.
  • Detalle de una solicitud: un ejemplo de la respuesta, el botón Pruebe este método y Fragmentos de código en varios lenguajes (cURL, Python, Java, Node, entre otros) para facilitar la integración.

Documentación de una API en el portal

4. Ver la ficha de un servidor MCP

Haga clic en la tarjeta de un servidor MCP para abrir su ficha. Un servidor MCP aparece en el catálogo solo si usted tiene acceso al menos a una de sus herramientas.

  • Herramientas: la lista de herramientas (tools) a las que tiene acceso.
  • Detalle de la herramienta: nombre, descripción y argumentos, con su tipo y descripción.
  • Endpoint del servidor MCP: la URL a la que se conecta el agente.
  • Dar de alta el servidor en tu agente: instrucciones de configuración para Claude Code, un Archivo de configuración u Otro cliente. El agente se autentica con la auth key de una de sus aplicaciones, que se envía en la cabecera auth-key. La encuentra en Mis aplicaciones.

Los conectores web alojados, como claude.ai o ChatGPT, todavía no se pueden usar con estos servidores: se conectan desde la infraestructura del proveedor y requieren un endpoint público por HTTPS con autenticación OAuth.

Ficha de un servidor MCP con herramientas y configuración del agente

Resultado esperado

Usted encuentra en el catálogo las APIs y los servidores MCP que necesita, revisa su documentación y obtiene lo necesario para integrarlos: la especificación OpenAPI y los fragmentos de código de una API, o el endpoint y la configuración de un servidor MCP.

Errores frecuentes

  • No aparece una API o un servidor MCP que espera ver: revise que no haya filtros aplicados (Quitar filtros) y busque en las dos pestañas. Si es un recurso privado, pida acceso al administrador de la organización.
  • No puede ver el detalle de un método: el método es privado y su usuario no tiene acceso.
  • El agente no se conecta al servidor MCP: verifique que use la auth key de una aplicación con acceso al servidor y que la envíe en la cabecera auth-key.

Artículos relacionados