Obtener la documentacion de un tema

GET

/api/guides/{topic}

Devuelve la documentacion de un modulo tal como esta publicada en mgpanel.co/docs/{topic}. Consulta opcional pensada para agentes: las herramientas MCP traen en su descripcion el contrato operativo, y esta guia aporta el porque, el flujo de trabajo y los casos borde.

Con format=outline devuelve solo el indice de secciones (barato). Con section=<section_id> devuelve unicamente esa seccion. Con format=blocks devuelve los bloques Editor.js con su block_id, que es lo que consume PATCH /api/blog/{article_id}/blocks para editar la propia documentacion.

El section_id de cada seccion es el block_id de su encabezado, asi que sirve tal cual para editarla.

Solicitud

Parámetros de ruta

Parámetros de consulta

Parámetros de Header

Respuestas

🟢200

application/json

Bodyapplication/json

🟠400

🟠404

🔴503

🟠403ForbiddenAccess

🟠429TooManyRequests

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location 'https://app.mgpanel.co/api/guides/tienda?format=&section=tpcfg_h' \
--header 'X-Account-Nick: {{ACCOUNT_NICK}}' \
--header 'Authorization: Bearer {{API_KEY}}' \
--header 'Content-Type: application/json'

Ejemplo de Respuesta

200 - Éxito

{
    "success": true,
    "topic": "tienda",
    "title": "Tienda On-line",
    "description": "Vende en linea desde tu sitio: catalogo, carrito, checkout y pedidos.",
    "url": "https://www.mgpanel.co/docs/tienda",
    "modified": "2026-09-18T10:12:44.000Z",
    "limits": {
        "variant_templates_max": 20
    },
    "sections": [
        {
            "section_id": "tpcfg_h",
            "heading": "4. Configuracion -> Tienda",
            "level": 2
        },
        {
            "section_id": "tpdep_h",
            "heading": "Abono: dejar que reserven con un anticipo",
            "level": 3
        }
    ],
    "content": "## 4. Configuracion -> Tienda\n\nDesde Configuracion > Tienda se define..."
}

Modificado en 2026-10-08 13:23:32

Listar temas de documentacion

Catálogo de estados