Foccuz Integration API
  1. API externa
Foccuz Integration API
  • API externa
    • Comenzando con Foccuz Integration API
    • Autenticación vía API Key
    • Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)
    • Colaboradores con Compensaciones Variables (Usuario/Colaborador)
    • Empresas (Clientes/Cuentas/Compañías)
    • Negocio (Operación, Venta, Cobranza, Acción clave)
    • Actividad (Acción, Productividad, Indicador)
    • Campos personalizados
    • Orden de ejecucción
    • Consideraciones
    • Flujos de ejemplo
    • Manejo de errores
    • v2
      • integration
        • deals
          • /v2/integration/deals
          • /v2/integration/deals
        • activities
          • /v2/integration/activities
          • /v2/integration/activities
        • account
          • /v2/integration/account
          • /v2/integration/account
        • sales-profile
          • /v2/integration/sales-profile
          • /v2/integration/sales-profile
  • Integraciones
    • Buk
      • Conectarse con Buk
  1. API externa

Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)

Rate Limiting#

Para garantizar la estabilidad de la plataforma y proteger contra abusos, la API de Foccuz aplica limitación de peticiones (rate limiting) a todos los clientes.
Límite máximo: 100 solicitudes
Ventana de tiempo: 60 segundos (1 minuto)
Estrategia: Ventana fija (fixed window)

Ejemplo#

Un cliente puede realizar hasta 100 solicitudes por minuto.
Si se excede este límite, la API devolverá:
Código de estado: 429 Too Many Requests
Cuerpo de error:
{
  "statusCode": 429,
  "error": "ER_TOO_MANY_REQUESTS",
  "message": "Rate limit exceeded"
}

Body Size Limiting#

Con el fin de optimizar el rendimiento y prevenir abusos (como ataques DoS con payloads excesivos), se aplica un límite al tamaño del cuerpo de la solicitud.
Tamaño máximo permitido: 1 MB
Tipos de contenido afectados:
application/json
application/x-www-form-urlencoded

Ejemplo de error#

Si un cliente envía un payload que excede este tamaño, la API devolverá:
Código de estado: 413 Payload Too Large
Cuerpo de error:
{
  "statusCode": 413,
  "error": "ER_PAYLOAD_TOO_LARGE",
  "message": "Payload too large"
}
Modificado en 2025-10-10 13:43:17
Anterior
Autenticación vía API Key
Siguiente
Colaboradores con Compensaciones Variables (Usuario/Colaborador)
Built with