Cliente

Validar código de ingreso del cliente

POST /v2/clients/validate-code

Valida el código de ingreso de un cliente y verifica su estado.

Headers requeridos

Content-Type: application/json

Parámetros de entrada (JSON)

{
  "code": "ABC123"
}

Campo	Tipo	Requerido	Descripción
code	string	Sí	Código de ingreso del cliente

Respuesta exitosa (200)

{
  "success": true,
  "message": "Cliente encontrado",
  "data": {
    "id": 1,
    "code": "ABC123",
    "name": "Empresa ejemplo",
    "status": "activo",
    "url_base": "https://example.com/",
  }
}

Respuestas de error

Cliente no encontrado (404)

{
  "success": false,
  "message": "Cliente no encontrado",
  "data": null
}

Cliente inactivo (403)

{
  "success": false,
  "message": "El cliente está inactivo",
  "data": null
}

Validación fallida (422)

{
  "message": "The code field is required.",
  "errors": {
    "code": [
      "The code field is required."
    ]
  }
}

Error del servidor (500)

{
  "success": false,
  "message": "Error al obtener el cliente",
  "data": null
}

Códigos de Estado HTTP

• 200: Cliente encontrado y activo
• 403: Cliente encontrado pero inactivo/bloqueado
• 404: Cliente no encontrado
• 422: Datos de entrada inválidos
• 500: Error interno del servidor

Ejemplo de uso

curl -X POST http://tu-dominio.com/api/v2/clients/validate-code \
  -H "Content-Type: application/json" \
  -d '{
    "code": "ABC123"
  }'

Ver también

• Obtener configuración del cliente
• Módulos habilitados

Notas Importantes

1. Validación de estado: El endpoint verifica que el cliente tenga estado “activo” (case-insensitive).
2. Validación del código: El código debe coincidir exactamente con el almacenado en la base de datos.
3. Formato de respuesta: Todas las respuestas siguen un formato consistente con success, message y data.