Documentación de la API 

Integre el motor de IA de diagnósticos botánicos de PlantCare directamente en su software empresarial.

Definición Interactiva de OpenAPI

La interfaz de PlantCare Enterprise utiliza la especificación OpenAPI (Swagger) para permitir que las empresas integren directamente nuestro motor de modelado predictivo de alta precisión.

swagger.yaml /v1/analyses/sync /v1/history /v1/stats /v1/iot/devices

URL de la definición unificada: https://api.plantcare.farm/v1/swagger.yaml

Optimización de Imágenes

Para ofrecer el mejor rendimiento y reducir el consumo de ancho de banda, las fotos de cultivos entrantes se preprocesan automáticamente en el API Gateway:

  • Compresión WebP: Convertidas al formato WebP con calidad 92.
  • Resolución Máxima: Redimensionadas a un máximo de 1024x1024px, manteniendo el aspecto.
  • Procesamiento en Red Privada: Todo el análisis ocurre dentro de los límites seguros de nuestra VPC.

Seguridad y Cumplimiento

Nuestra API impone los más altos estándares para aislar la telemetría y proteger los accesos a datos de cultivos:

  • Seguridad sin Claves: Autenticación mediante Workload Identity Federation (WIF).
  • Escáner de Malware: Imágenes analizadas en busca de firmas maliciosas en el punto de entrada.
  • Guía Detallada: Conozca nuestro Modelo de Seguridad y Autorización Zero-Trust.

Flujo de Trabajo B2B

sequenceDiagram participant Client as "Cliente Enterprise" participant API as "API Gateway" participant GCS as "Almacén de Objetos" participant Scan as "Malware Scanner" participant Proc as "Procesador de Imágenes" participant AI as "Motor de IA" Client->>API: "POST /v1/analyses/sync (Authorization: Bearer pk_ent_...)" API->>GCS: "Cargar Imagen (Temp)" Note over GCS,Scan: "GCS Trigger: scanNewFile" Scan->>Scan: "Escanear en busca de Malware" API->>Proc: "Solicitar Optimización (Auth con Token Firmado)" Proc->>Proc: "Convertir Imagen (92%, 1024px)" Proc-->>API: "URL de Imagen Optimizada" API->>AI: "Analizar con Imagen Optimizada" AI-->>API: "Resultados del Análisis" API-->>Client: "JSON (Diagnóstico + Ruta de Imagen)" Note over API,Proc: "La imagen original se elimina en 24h"

Inicio Rápido para Diagnóstico Síncrono

Envíe una consulta POST síncrona con una foto codificada en base64 e indicadores de ubicación para ejecutar la evaluación del modelo:

curl -X POST https://api.plantcare.farm/v1/analyses/sync \
  -H "Authorization: Bearer pk_ent_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageBase64": "...",
    "sunExposure": "Pleno Sol",
    "latitude": 40.7128,
    "longitude": -74.0060,
    "placement": "exterior",
    "language": "es"
  }'

Garantía de Idempotencia de Transacciones

Para evitar ejecuciones de análisis duplicadas, proteger sus cuotas de consumo y prevenir condiciones de carrera debidas a reintentos de red, la API de PlantCare admite claves de idempotencia definidas por el cliente.

Idempotency-Key
Cadena UUID v4 estándar
Retención de resultados por 24h

Debe incluir la cabecera en las peticiones de análisis de tipo escritura (como el inicio asíncrono de diagnósticos en /v0/analysis/start o /v1/analyses):

curl -X POST https://api.plantcare.farm/v0/analysis/start \
  -H "Authorization: Bearer pk_ent_your_token_here" \
  -H "Idempotency-Key: 9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d" \
  -H "Content-Type: application/json" \
  -d '{
    "imageBase64": "..."
  }'

Comportamientos de Resultados Duplicados:
• Transacciones Completadas: Devuelve el resultado del análisis guardado en caché al instante, sin consumir cuota adicional ni ejecutar una nueva inferencia de IA generativa.
• Transacciones Pendientes: Devuelve un estado 202 Accepted junto con el ID de transacción existente, lo que evita que se inicien ejecuciones redundantes.

¿Necesita detalles de arquitectura? Revise nuestra Guía de Arquitectura y Escalabilidad. ¿Necesita acceso? Por favor, contacte a nuestro Equipo de Ventas.