Saltar al contenido

API de Necesito Camarero

Integra tu sistema con nuestra plataforma de empleo. Incluida en el Plan Empresa.

Ver Plan Empresa

Comenzando

1. Acceso a la API

API de Empresas

Incluida en el Plan Empresa. Gestiona ofertas de trabajo y candidatos desde tu propio software.

Ver Plan Empresa

2. Requisitos

  • Plan Empresa con suscripción activa (durante la prueba gratuita la API todavía no está disponible)
  • API Key generada desde

3. Autenticación

Todas las peticiones deben incluir tu API Key en el header Authorization:

Authorization: Bearer nec_tu_api_key_aqui

También puedes usar el header X-API-Key

4. URL Base

https://api.necesitocamarero.com/api/v1

Desarrollo: http://localhost:3496/api/v1

5. Rate Limits

Cada API Key admite hasta 1000 peticiones por hora (ventana de una hora). Al terminar la hora el contador vuelve a cero.

Cada respuesta incluye las cabeceras X-RateLimit-Limit y X-RateLimit-Remaining. Si superas el límite recibes un 429 con la cabecera Retry-After (segundos hasta poder reintentar).

6. Lista blanca de IPs

Al crear o editar una API Key puedes indicar las IPs desde las que se permite usarla. Las peticiones desde cualquier otra IP se rechazan.

7. Errores

  • 401: API Key ausente, no válida, revocada o caducada.
  • 403: tu empresa no tiene la API disponible (no tiene Plan Empresa o está en prueba gratuita), o la IP no está en la lista blanca. Cuando falta el plan, el cuerpo es:
{
  "code": "PLAN_FEATURE_REQUIRED",
  "feature": "api_access",
  "requiredPlan": "enterprise",
  "message": "La API está incluida en el Plan Empresa."
}
  • 429: has superado el límite de peticiones de la hora. Espera los segundos indicados en Retry-After.

8. Formato de Respuesta

Todas las respuestas son en formato JSON:

{
  "success": true,
  "data": { ... },
  "total": 10,
  "page": 1,
  "limit": 20
}

¿Necesitas ayuda?

Si tienes preguntas o problemas con la API, contacta a nuestro equipo de soporte.

Contactar Soporte