Documentación de la API
Registro de cambios
Las versiones del contrato de la API, de la más reciente a la más antigua. Todas son compatibles: un cliente escrito para la 1.0 sigue funcionando.
Versión actual
v1 · 1.2.0Cómo leer las versiones
La ruta lleva la versión mayor (/v1); info.version del documento OpenAPI lleva los cambios compatibles que se enumeran aquí. Todos son aditivos: ningún campo retirado, ningún campo obligatorio añadido. Una ruptura daría lugar a /v2, servida en paralelo. Cada entrada lleva la fecha del cambio.
1.2.0 — Los webhooks firmados.
- Puntos de acceso de los webhooks:
GETyPOST /v1/webhooks,GET,PATCHyDELETE /v1/webhooks/{id},POST /v1/webhooks/{id}/rotateyPOST /v1/webhooks/{id}/test. La lectura requiereread, cualquier cambiowrite; como máximo diez puntos de conexión por cuenta. - Cuatro eventos —
search.finished,prospect.replied,application.received,partner.approved— firmados según la especificación Standard Webhooks (webhook-id,webhook-timestamp,webhook-signature). El secretowhsec_se muestra una sola vez; tras una rotación, el anterior sigue firmando durante 24 horas. - Una entrega fallida se reintenta al cabo de 1 minuto, 5 minutos, 30 minutos, 2 horas y 12 horas. Los contenidos llevan identificadores y recuentos, nunca una dirección de correo ni un mensaje.
- Los webhooks no se exponen como herramientas MCP: sus secretos acabarían en las transcripciones de los asistentes.
- Una ruta desconocida bajo
/api/v1responde ahora 404not_foundenapplication/problem+json, tras la autenticación, en lugar de una página HTML.
1.1.0 — La captación de socios por la API, y el servidor MCP.
- 29 operaciones nuevas para todo lo que hacen las pantallas de captación: los sitios, los criterios y sus términos temáticos generados, la búsqueda de socios y sus últimos resultados, la preselección y su paso a prospectos, los prospectos y la búsqueda de correo de pago, la búsqueda conversacional, el índice de creadores (búsqueda, ficha, perfiles similares, biblioteca de creadores encontrados), la competencia y la prospección: buzones, secuencias, inscripción. Ningún punto de acceso envía un correo directamente.
- Los ámbitos
read,search,writeyspend; las claves creadas antes de la 1.1 conservan exactamenteread. - La confirmación del coste: una operación que gasta créditos de proveedor requiere
spendy unconfirmCostal menos igual a la estimación; si no, responde 402cost_confirmation_requiredcon la estimación enerror.detailsy no gasta nada. Los gastos confirmados quedan registrados. Idempotency-Keyen las escrituras (24 horas, solo los éxitos), cuerpos de petición limitados a 32 KiB (413payload_too_large), un tope de uso por cuenta además del tope por clave y 20 códigos de error nuevos.- El servidor MCP en
/api/mcp(Streamable HTTP, versiones del protocolo de 2025-11-25 a 2024-11-05): 29 herramientas calcadas de la API, con las mismas claves y ámbitos; las herramientas de pago se confirman en dos pasos con unconfirmToken.
- Las búsquedas guardadas:
GET /v1/sites/{id}/partner-search/historyy/history/{searchId}; herramientas MCPlist_saved_searchesyget_saved_search. - Los errores pasan a ser documentos de problema RFC 9457 (
application/problem+json:type,title,status,detail,instance) que conservan sin cambios el miembroerrorde la 1.0; cadatypelleva a su fila en la página de errores. Los 401 y 403 llevanWWW-Authenticate. RateLimit-PolicyyRateLimit(borrador del IETF) junto aX-RateLimit-*;X-Request-Idytraceparentdevueltos; unETagen cada GET,If-None-Matchrespondido con304.- Descubrimiento:
/api/v1/openapi.json,/llms.txty/llms-full.txt. - MCP: inicio de sesión con OAuth 2.1 (especificación de autorización de MCP 2025-11-25, PKCE S256, metadatos de recurso protegido, ficha del servidor en
/.well-known/mcp.json), ámbitos por defectoread search;outputSchemaystructuredContenten cada herramienta;enrol_in_sequencese confirma en dos pasos. - Los prospectos ganan un campo
stage, la etapa del embudo que muestra la pantalla Socios.
1.0.0 — El primer contrato, de solo lectura.
- Cuatro operaciones: el directorio público de programas (
GET /v1/programs,GET /v1/programs/{slug}), la cuenta que llama (GET /v1/me) y sus comisiones (GET /v1/commissions). - Claves portadoras
gaff_live_…, guardadas como huella y mostradas una sola vez; un tope de uso por clave según el plan, conX-RateLimit-Limit,X-RateLimit-RemainingyRetry-After. - Paginación por cursor, orígenes de navegador rechazados (CORS) y un documento OpenAPI 3.1 derivado de los esquemas que aplican las rutas.
- Los puntos de acceso del directorio adoptan su ruta en inglés:
/v1/programmespasa a ser/v1/programs.