Saltar al contenido principal

Documentación para agentes de IA

Cada página de esta documentación está disponible en un formato legible por máquina. Si desarrollas un agente de IA, una canalización de recuperación o un asistente interno que responde preguntas sobre MONEI, usa estos endpoints en lugar de extraer el HTML renderizado.

Qué está disponible

RecursoURLFormato
Índice de páginashttps://docs.monei.com/llms.txtMarkdown
Cualquier página en Markdownhttps://docs.monei.com/<ruta>.mdMarkdown
Negociación de MarkdownAccept: text/markdown en cualquier URLMarkdown
Servidor MCPVer Servidor MCPMCP
API de búsquedahttps://docs-search.monei.comJSON
Lista de URL canónicashttps://docs.monei.com/sitemap.xmlXML
Especificación de la API RESThttps://js.monei.com/api/v1/openapi.jsonOpenAPI 3
Esquema GraphQLhttps://graphql.monei.com/GraphQL (introspección)
Colección de Postmanhttps://postman.monei.com/Postman

Lee cualquier página en Markdown

Quita la barra final de una URL de la documentación y añade .md. Obtienes el contenido de la página sin navegación, scripts ni marcado de diseño:

curl https://docs.monei.com/es/payments/refunds.md

Las páginas en inglés funcionan igual, sin el prefijo /es/:

curl https://docs.monei.com/payments/refunds.md

https://docs.monei.com/llms.txt enumera todas las páginas con su título, descripción y URL de Markdown, agrupadas por sección. Empieza ahí si quieres recorrer todo el corpus.

También puedes pedirla por negociación de contenido, sin cambiar la URL. Envía Accept: text/markdown a cualquier URL de la documentación y obtienes el Markdown de esa página; la respuesta lleva Vary: Accept:

curl -H "Accept: text/markdown" https://docs.monei.com/es/payments/refunds/
tip

La URL .md y la cabecera Accept son equivalentes: usa la que te resulte más cómoda. Lo que ya lleva extensión, como /llms.txt o /sitemap.xml, se sirve tal cual en ambos casos.

Servidor MCP

El índice de la documentación se publica como un servidor Model Context Protocol alojado. Apunta un cliente MCP a esta URL: no hay que obtener ninguna clave, ni crear una cuenta, ni instalar nada:

https://docs-mcp.monei.com/mcp

Añádelo a tu cliente

claude mcp add --transport http monei-docs https://docs-mcp.monei.com/mcp

Comprueba que se ha registrado con claude mcp list.

Cuando esté conectado, pregúntale a tu agente algo que responda la documentación —«¿cómo hago un reembolso con MONEI?» o «¿qué métodos de pago admiten preautorización?»— y buscará en estas páginas en lugar de improvisar.

Expone dos herramientas:

HerramientaQué hace
algolia_search_index_moneiBusca en la documentación. El mismo índice que el buscador del sitio.
algolia_search_for_facet_valuesLista los valores de una faceta, como lang o record_type.

Los resultados son los mismos registros de DocSearch que se describen en Estructura de la respuesta, así que cada resultado lleva el ancla de sección que citar y una url cuya versión en Markdown puedes obtener (quita el #ancla y la barra final, y añade .md).

info

El servidor es de solo lectura: puede buscar en la documentación y nada más. No accede a ninguna cuenta, pago ni dato de cliente de MONEI.

El índice de la documentación lo sirve Algolia DocSearch. Consúltalo por HTTP sin credenciales: la clave de búsqueda se añade por ti en el edge:

ParámetroValor
Endpointhttps://docs-search.monei.com
Nombre del índicemonei

El formato de petición y respuesta es el de Algolia, así que cualquier cliente de Algolia funciona si lo apuntas a este host.

curl -G "https://docs-search.monei.com/1/indexes/monei" \
--data-urlencode "query=reembolsar un pago" \
--data-urlencode "filters=lang:es AND record_type:docs" \
--data-urlencode "hitsPerPage=5" \
--data-urlencode "attributesToRetrieve=url,hierarchy,content"

Filtros

Combina estos atributos en el parámetro filters para acotar una consulta:

AtributoValoresÚsalo para
langen, esDevolver un solo idioma en lugar de los dos.
record_typedocs, apiSeparar las guías de la referencia de la API generada.
typecontent, lvl1lvl6Priorizar el texto del cuerpo sobre los títulos.

Estructura de la respuesta

Cada resultado es un registro de DocSearch: una sección de una página, no una página completa.

  • url: la URL canónica, con el ancla de la sección coincidente. Para obtener el Markdown, quita primero el #ancla, luego la barra final, y añade .md: /payments/refunds/#timing pasa a ser /payments/refunds.md. Si añades .md a la URL completa obtienes #timing.md, que es solo un fragmento y sigue pidiendo la página HTML.
  • hierarchy.lvl0lvl6: la jerarquía de títulos, desde la sección hasta el título coincidente.
  • content: el texto del cuerpo de la sección, o null cuando el registro es un título.

Como cada resultado lleva un ancla de sección, cita la sección exacta (/payments/refunds/#timing) en lugar de remitir al lector a la página completa.

aviso

La búsqueda es de solo lectura y la comparte todo el mundo que use esta documentación. Almacena en caché lo que recuperes y no uses la búsqueda para replicar el corpus: llms.txt y las URL .md existen para la lectura masiva.

Especificaciones de las API

  • OpenAPI: https://js.monei.com/api/v1/openapi.json describe cada endpoint REST, cuerpo de solicitud y esquema de respuesta. Es la fuente de la referencia de la API REST.
  • GraphQL: https://graphql.monei.com/ acepta consultas de introspección estándar. Consulta la referencia de la API GraphQL y MONEI Connect para saber a quién está dirigida.
  • Postman: https://postman.monei.com/ es una colección predefinida para probar la API REST.

Para llamar a cualquiera de las dos API necesitas una clave de API de tu Panel de MONEI. Usa una clave de prueba mientras desarrollas; consulta Pruebas y puesta en marcha.

Rastreo

https://docs.monei.com/robots.txt permite todos los rastreadores, incluidos GPTBot, ClaudeBot, Google-Extended, PerplexityBot y Amazonbot. Las rutas que no existen devuelven un HTTP 404 real, por lo que puedes confiar en que un 404 significa que la página no existe.

Preguntas frecuentes

¿Uso el servidor MCP o la API de búsqueda?

Usa el servidor MCP si tu cliente habla MCP: no necesita credenciales ni código. Usa la API de búsqueda cuando escribas tu propia canalización de recuperación y quieras control directo sobre los filtros y la paginación. Ambos consultan el mismo índice.

¿Necesito una clave de API para buscar?

No. docs-search.monei.com añade una clave de solo búsqueda en el edge, así que tu cliente no envía nada. Consulta el índice de la documentación y nada más: no da acceso a tu cuenta de MONEI.

¿Qué URL debe citar un agente?

Cita la URL HTML, incluida el ancla de la sección. Es la dirección canónica que una persona puede abrir. Para leer esa página en Markdown, quita antes el ancla y la barra final, y luego añade .md.