Qbox
Documentación

Nivel 1 · Conectado

El plano y las fotos

El SVG de cada planta, con el id de cada trastero, y las fotos del centro.

El plano

PUT /facilities/{facilityId}/floor-plan, con version y sus floors: el id, el name («Planta baja») y el svg de cada planta.

  • Es el SVG de tu software, el mismo que usan sus webs: el portal lo limpia y solo lo colorea por estado. Nunca lo redibuja.
  • Solo formas y textos: sin scripts, imágenes, enlaces ni fuentes de fuera. Hasta 2 MB por planta y 10 plantas.
  • La forma de cada trastero lleva data-unit-id con su id. Una forma con un data-unit-id que no es de ningún trastero no deja publicar el plano (unknown_unit_in_plan); un trastero sin forma, sí, con el aviso unit_not_in_plan.
SVG
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 600 320">
  <g data-unit-id="T-021">
    <rect x="20" y="20" width="120" height="120" fill="#fff" stroke="#1F1B18"/>
    <text x="80" y="88" text-anchor="middle">21</text>
  </g>
</svg>

Las fotos

  • PUT /facilities/{facilityId}/photos/{photoId}, con la imagen tal cual en el cuerpo (Content-Type: image/jpeg, image/png o image/webp), de hasta 15 MB y de 800 px o más por el lado largo. El portal la rehace: derecha, reducida y sin metadatos.
  • PUT /facilities/{facilityId}/photos, con version y photos: su id y, si quieres, su pie (caption), en el orden en que salen. Las que no estén se quitan. Hasta 20.
  • No las descargamos de una dirección: así nadie las enlaza ni tenemos que fiarnos de un servidor de fuera.
curl
curl -X PUT https://api.findqbox.com/connect/v1/facilities/madrid-01/photos/foto-1 \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: image/jpeg" \
  --data-binary @pasillo.jpg

Si tu software no manda fotos ni descripción, las puede poner la gestora en Qbox. Lo que manda tu software manda sobre lo suyo.

¿Dudas? Escríbenos a team@findqbox.com.