Reclee

Ayuda y rutas públicas

La búsqueda en el centro de ayuda, el catálogo público de planes y el documento OpenAPI.

Esta página junta tres rutas que no pertenecen a ningún área de producto: la búsqueda en el centro de ayuda de Reclee, que usa tu API key, y dos rutas públicas que no llevan key: el catálogo de planes y el documento OpenAPI de la API.

Las rutas públicas solo aceptan GET (y HEAD); cualquier otro método contesta 405 METHOD_NOT_ALLOWED. Sus respuestas exitosas se cachean (Cache-Control: public, s-maxage=300), así que un cambio puede tardar hasta cinco minutos en verse.

Centro de ayuda

GET /help/articles

GET/help/articles

Busca en el centro de ayuda de Reclee los fragmentos de artículo que responden una pregunta, por significado y no por palabras exactas. Es la misma búsqueda que usa el asistente para contestar preguntas sobre cómo se usa Reclee. Devuelve hasta 4 fragmentos, cada uno con el enlace a su sección en help.reclee.com. No consume el uso de IA del plan.

CampoTipoRequeridoDescripción
querystringSíLa pregunta, de 2 a 500 caracteres.
languageenumOpcionalIdioma de los artículos: es o en. Default es.
curl -G https://app.reclee.com/api/v1/help/articles \
  -H "Authorization: Bearer rcl_..." \
  --data-urlencode "query=¿Cómo invito a alguien a mi workspace?"

Respuesta (extracto):

{
  "locale": "es",
  "answered": true,
  "fragments": [
    {
      "articleTitle": "Invitar a tu equipo",
      "sectionTitle": "Mandar una invitación",
      "url": "https://help.reclee.com/es/…#mandar-una-invitacion",
      "content": "Desde Configuración → Miembros, elige Invitar…"
    }
  ]
}
  • answered: false con fragments: [] significa que ningún artículo responde la pregunta. No es un error: la pregunta queda registrada para que el equipo de Reclee mejore la ayuda.
  • sectionTitle es null cuando el fragmento es la introducción del artículo.
CódigoStatusCuándo
INVALID400Falta query, o tiene menos de 2 o más de 500 caracteres.
HELP_UNAVAILABLE503La búsqueda no está disponible en este momento. Reintenta más tarde.

Planes (público)

GET /public/plans

GET/public/plans

Devuelve el catálogo de planes que se venden por autoservicio, con sus precios de lista, tal como lo muestra la página de precios. No lleva API key. Para leer el plan de tu propio workspace, usa la referencia de facturación.

curl https://app.reclee.com/api/v1/public/plans

Respuesta (extracto; los precios son ilustrativos, la respuesta real trae los vigentes):

{
  "plans": [
    {
      "plan": "FREE",
      "version": 1,
      "priceMonthlyUsd": 0,
      "priceYearlyUsd": 0,
      "maxSeats": 1,
      "profiles": 500,
      "profilesPerSeat": false,
      "credits": 0,
      "creditsPerSeat": false,
      "trialDays": null
    },
    {
      "plan": "PRO",
      "version": 1,
      "priceMonthlyUsd": 99,
      "priceYearlyUsd": 990,
      "maxSeats": null,
      "profiles": 3000,
      "profilesPerSeat": true,
      "credits": 500,
      "creditsPerSeat": true,
      "trialDays": 14
    }
  ],
  "creditUsd": 0.01,
  "extraProfileUsd": 0.0486,
  "profilesPerSearch": 500,
  "scaleFromSeats": 7,
  "profilesPerScaleBundle": 3000
}
CampoQué es
plans[].planFREE, STARTER o PRO, en ese orden.
plans[].priceMonthlyUsd / priceYearlyUsdPrecio por asiento, por mes y por el año entero.
plans[].maxSeatsMáximo de asientos del plan; null es sin tope.
plans[].profiles / profilesPerSeatPerfiles por mes que incluye el plan, y si ese número es por asiento.
plans[].credits / creditsPerSeatCréditos por mes que incluye el plan, y si son por asiento.
plans[].trialDaysDías de prueba, o null si el plan no tiene.
creditUsdPrecio de un crédito comprado.
extraProfileUsdPrecio de un perfil por encima de lo que incluye el plan, pagado con créditos.
profilesPerSearchTope de perfiles de una búsqueda de sourcing.
scaleFromSeatsDesde cuántos asientos el plan es SCALE, que se vende por contacto comercial.
profilesPerScaleBundlePerfiles que suma cada paquete del plan SCALE.

Si el catálogo no se puede leer, contesta 500 UNEXPECTED (los errores no se cachean).

OpenAPI (público)

GET /openapi.json

GET/openapi.json

Devuelve el documento OpenAPI 3.1 de la API, generado a partir de las rutas y las acciones: todas las rutas con sus métodos, los parámetros de paginación, el header Idempotency-Key donde aplica, el JSON Schema de entrada de cada acción y la tabla x-error-status (código de error → status HTTP). No lleva API key: puedes leerlo antes de tener una.

curl https://app.reclee.com/api/v1/openapi.json -o reclee-openapi.json

Respuesta (extracto):

{
  "openapi": "3.1.0",
  "info": { "title": "Reclee API", "version": "v1", "description": "…" },
  "servers": [{ "url": "https://app.reclee.com/api/v1" }],
  "security": [{ "apiKey": [] }],
  "paths": { "/crm/leads": { "get": { "…": "…" }, "post": { "…": "…" } } },
  "components": {
    "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer" } },
    "parameters": { "…": "…" },
    "schemas": { "…": "…" }
  },
  "x-error-status": { "UNAUTHENTICATED": 401, "NOT_FOUND": 404, "RATE_LIMITED": 429 }
}

servers trae la dirección base completa (https://app.reclee.com/api/v1), así que un cliente generado desde el documento descargado ya apunta a la API.

Cómo usarlo para generar un cliente o explorar la API: ver OpenAPI.

En esta página