Documentación V2

Antes de comenzar

Todos los campos obligatorios están marcados. Los campos sin marca se consideran opcionales.

📥 Colección de Postman
Puedes descargar la colección completa de Postman usando el botón en la esquina superior derecha . Esta incluye:

• Todos los endpoints disponibles agrupados por recurso

• URL base preconfigurada

• Configuración de autorización lista para usar

Para comenzar a usarla:

1. Importa la colección en Postman

2. Haz clic en el nombre de la colección en la barra lateral

3. Ve a la pestaña Authorization

4. Selecciona API Key

   - En Key, escribe Authorization

   - En Value, pega tu token (ejemplo: eyJhbGciOiJIUzI1NiIsInR...)

   - En Add to, selecciona Header

5. Guarda y ya estarás listo para probar la API. Todas las solicitudes incluirán automáticamente el encabezado Authorization.

📌 Notas importantes:

• Al enviar archivos, usa modo binario, no form-data.

• No necesitas configurar los encabezados manualmente en cada solicitud — la autorización se aplicará de forma global.

📅 Formato de fechas
Todas las fechas entregadas por la API siguen el mismo formato: YYYY-MM-DD (hora UTC).

• YYYY Año con cuatro dígitos → 2023

• MM Mes con dos dígitos → 09

• DD Día con dos dígitos → 01

📂 Subida de archivos
La carga de archivos en nuestra API se realiza en dos pasos, usando URLs temporales. Este enfoque es seguro y eficiente.

1. Realiza una solicitud al endpoint de carga de archivos. Recibirás una respuesta con:

   • url: URL temporal donde se debe subir el archivo (válida por pocos minutos).

   • path: Cadena que referencia el archivo en nuestro sistema (se usa después al vincularlo).

   POST https://app.calidadcloud.com/api/v2/public/api/files/upload-url Body (JSON): { "extension": "png" }
   

2. Haz una solicitud PUT a url y envía tu archivo como binario (sin JSON, sin form-data).

   • response: Al subir el archivo, responderá con un 200 OK vacío.

   PUT {url} Body (binary): [Tu archivo]
   

3. Finalmente, al crear un nuevo registro (por ejemplo, proyecto, archivo de inspección, etc.), incluye solo el valor de path (entregado en el paso 1) en el campo correspondiente.

   POST https://app.calidadcloud.com/api/v2/public/api/projects/1 Body (JSON): { "image_url": "uploads/some/folder/uuid.png" }
   

✅ Códigos de respuesta

• 200 OK → Solicitud exitosa.

• 201 Created → Se creó un nuevo recurso.

• 204 No Content → Solicitud exitosa, sin contenido devuelto.

• 401 Unauthenticated → Token inválido o ausente. Se requiere autenticación.

• 402 Payment Required → Acceso denegado por problemas de facturación.

• 403 Forbidden → Acción no autorizada para este usuario.

• 404 Not Found → El recurso solicitado no existe.

• 422 Validation Error → Parámetros inválidos. Recibirás una lista de errores por campo.

🧾 Paginación
Los endpoints de listado usan paginación por defecto. Puedes controlarla con los siguientes parámetros de consulta:

• page: Número de página (ejemplo: ?page=2)

• rowsPerPage: Elementos por página. Por defecto es 50 y el valor máximo es 1000 (ejemplo: ?rowsPerPage=25).