API de Brilliant Directories — Integración universal con IA

Dale a cualquier agente de IA acceso total a tu sitio de BD con una sola clave API.

170 endpoints a través de 32 recursos: miembros, clientes potenciales, publicaciones, reseñas, categorías, plantillas de correo electrónico, páginas (página de inicio, páginas de destino), redirecciones 301, listas inteligentes, widgets, menús, formularios, planes de membresía y más.

Inicio rápido en 30 segundos

Un comando. Responde dos preguntas. Listo.

npx brilliant-directories-mcp --setup

El asistente te pedirá la URL de tu sitio BD y tu clave API, probará la conexión, te preguntará qué aplicación utilizas (Cursor / Claude Desktop / Windsurf / Claude Code) y escribirá la configuración por ti. Sin edición de JSON.

Reinicia tu aplicación y luego pregúntale a tu IA:

"List members on my BD site"

Obtén tu clave API en BD Admin > Developer Hub > Generate API Key.

Para agentes de IA / scripts (no interactivos)

Si un agente de IA te está guiando, puede hacer que pegues un solo comando con todo prellenado:

npx brilliant-directories-mcp --setup --url https://your-site.com --api-key YOUR_KEY --client cursor

Esto ejecuta la configuración completa de principio a fin sin avisos. Reemplaza cursor con claude-desktop, windsurf, claude-code o print (imprime la configuración JSON en lugar de escribir un archivo).

Configuración por plataforma

Claude Code / Cursor / Windsurf / Cline (MCP)

Opción A — npx (recomendado, no requiere instalación):

claude mcp add bd-api -- npx brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com

Opción B — Instalación global:

npm install -g brilliant-directories-mcp
claude mcp add bd-api -- brilliant-directories-mcp --api-key YOUR_KEY --url https://your-site.com

Cursor / Windsurf / Cline — agrégalo a tu archivo de configuración MCP (~/.cursor/mcp.json, etc.):

{
  "mcpServers": {
    "bd-api": {
      "command": "npx",
      "args": ["-y", "brilliant-directories-mcp", "--api-key", "YOUR_KEY", "--url", "https://your-site.com"]
    }
  }
}

Luego pregúntale a tu IA: "List all members on my BD site" o "Create a new member with email john@example.com"

ChatGPT (GPT Actions)

1. En tu GPT: Configure > Actions > Create new action

2. En Schema, elige Import from URL y pega:

   https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

3. Cuando se te solicite bd_site_url, ingresa tu sitio BD (ej. https://mysite.com)

4. Configura la autenticación: API Key, Auth Type: Custom, Header Name: X-Api-Key, pega tu clave

n8n

Opción A — Importar especificación OpenAPI (recomendado):

Importa la URL de la especificación como una definición de API personalizada:

https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

n8n te pedirá la URL de tu sitio BD y tu clave API al importar. No requiere edición de archivos.

Opción B — Nodo de solicitud HTTP simple:

1. Crea un nuevo flujo de trabajo, agrega un nodo HTTP Request

2. Configura:

   • Método: GET

   • URL: https://your-site.com/api/v2/user/get

   • Encabezado: X-Api-Key: YOUR_KEY

Make / Zapier

Make: Crea una aplicación personalizada usando la especificación OpenAPI, o usa el módulo HTTP con el encabezado X-Api-Key.

Zapier: Si ya tienes la aplicación BD Zapier, utiliza la misma API subyacente. Para nuevos endpoints, usa Webhooks by Zapier con el encabezado X-Api-Key.

curl / Cualquier cliente HTTP

# Verify your API key
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/token/verify

# List members
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/user/get?limit=10

# Create a member
curl -X POST -H "X-Api-Key: YOUR_KEY" \
  -d "email=new@example.com&password=secret123&subscription_id=1&first_name=Jane&last_name=Doe" \
  https://your-site.com/api/v2/user/create

# Search members
curl -X POST -H "X-Api-Key: YOUR_KEY" \
  -d "q=dentist&address=Los Angeles&limit=10" \
  https://your-site.com/api/v2/user/search

# Update a member
curl -X PUT -H "X-Api-Key: YOUR_KEY" \
  -d "user_id=42&company=New Company Name" \
  https://your-site.com/api/v2/user/update

Solución de problemas

Verifica tu configuración con un comando:

npx brilliant-directories-mcp --verify --api-key YOUR_KEY --url https://your-site.com

Imprime OK si las credenciales funcionan, FAIL con el error en caso contrario. Un buen primer paso para cualquier problema de conectividad.

Modo de depuración — mira exactamente qué está sucediendo:

npx brilliant-directories-mcp --debug --verify --api-key YOUR_KEY --url https://your-site.com

Registra cada solicitud y respuesta de la API en stderr (tu clave API se redacta automáticamente), luego sale. Útil cuando algo no funciona y quieres compartir la salida con el soporte de BD.

Elimina --verify para iniciar el servidor stdio MCP completo con registro de depuración; parecerá que se bloquea en una terminal normal porque los servidores MCP se ejecutan indefinidamente a través de stdio, esperando a que un cliente de IA se conecte. Usa --debug --verify para una depuración única desde un shell.

Problemas comunes:

• 401 Unauthorized — la clave API es incorrecta, ha sido revocada o carece de permiso para el endpoint

• 404 Not Found — la URL del sitio es incorrecta (verifica si hay errores tipográficos; https:// se agrega automáticamente si falta)

• 429 Too Many Requests — se alcanzó el límite de velocidad (100 req/60s por defecto); espera o aumenta el límite en el administrador de BD

• Unknown tool (de Claude) — el servidor MCP no cargó la especificación OpenAPI; reinstala con npm install -g brilliant-directories-mcp

Autenticación

Todas las solicitudes requieren el encabezado X-Api-Key:

X-Api-Key: your-api-key-here

Las claves API están limitadas por permisos: tú controlas a qué endpoints puede acceder cada clave.

Límites de velocidad

Por defecto: 100 solicitudes por cada 60 segundos por clave API. Bajo petición: hasta 1.000 solicitudes por minuto; contacta al equipo de soporte de Brilliant Directories para aumentar el límite de tu sitio (cualquier valor entre 100 y 1.000/min).

El límite lo establece BD en el lado del servidor, no es una configuración de autoservicio en tu administrador. Si esperas un uso intensivo de la API, envía un correo electrónico al soporte de BD antes de realizar operaciones masivas y solicita un aumento temporal o permanente.

Cuando se excede, la API devuelve HTTP 429 Too Many Requests. El servidor MCP muestra esto como un error procesable para tu agente de IA; sabrá que debe esperar o recomendar solicitar un límite más alto.

Planifica operaciones masivas: si le pides a tu agente que importe/actualice cientos de registros, (a) solicita primero un límite más alto al soporte de BD, o (b) dile al agente que marque su propio ritmo (ej. "importa estos 500 miembros, haciendo pausas para respetar el límite de 100/min").

Paginación

Todos los endpoints de lista admiten paginación:

La respuesta incluye: total, current_page, total_pages, next_page, prev_page

Filtrado

Todos los endpoints de lista admiten filtrado:

GET /api/v2/user/get?property=city&property_value=Los Angeles&property_operator==

Filtros múltiples:

GET /api/v2/user/get?property[]=city&property_value[]=Los Angeles&property[]=state_code&property_value[]=CA

Operadores: =, LIKE, >, <, >=, `<=

Ordenamiento

GET /api/v2/user/get?order_column=last_name&order_type=ASC

Recursos disponibles

Descubrimiento de campos

Algunos endpoints admiten el descubrimiento dinámico de campos:

# Get all available user fields
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/user/fields

# Get custom fields for a specific post type
curl -H "X-Api-Key: YOUR_KEY" https://your-site.com/api/v2/data_posts/fields?form_name=my-form

Archivos

URLs de activos estables

Para herramientas que importan especificaciones por URL (ChatGPT Actions, n8n, Postman):

https://raw.githubusercontent.com/brilliantdirectories/brilliant-directories-mcp/main/openapi/bd-api.json

Seguridad

• Las claves API nunca se incrustan en el paquete

• Todas las solicitudes van directamente desde la máquina del usuario a su sitio BD

• Ningún dato pasa a través de servidores de terceros

• Los permisos de la clave API controlan a qué endpoints se puede acceder

• Trata tu clave API como una contraseña

Soporte

• Soporte de BD: https://support.brilliantdirectories.com

• Documentación de la API: https://support.brilliantdirectories.com/support/solutions/articles/12000108045