La API de Qbox para softwares de trasteros
Publica los centros de tus clientes con sus trasteros al momento, recibe sus solicitudes y, después, alquila online. Una API REST con OpenAPI 3.1, avisos firmados y un entorno de pruebas.
curl -X PUT https://api.findqbox.com/connect/v1/facilities/madrid-01/units/T-021 \
-H "Authorization: Bearer $TOKEN" \
-H "Idempotency-Key: 5b1d0c3e-8f6a-4c2e-9d1b-7a0e2f4c6b11" \
-H "Content-Type: application/json" \
-d '{"number": "21", "areaM2": 2.6, "status": "available",
"monthlyPrice": 49, "unitTypeId": "S"}'Empieza en tres pasos
Pide tus credenciales
Al aceptar tu petición, las de pruebas. Con ellas, el token de tu software:
curlcurl -X POST https://api.findqbox.com/connect/oauth/token \ -d grant_type=client_credentials \ -d client_id=$CLIENT_ID \ -d client_secret=$CLIENT_SECRETManda un centro
Con el permiso de la gestora, su dirección completa, su punto y su horario:
curlcurl -X PUT https://api.findqbox.com/connect/v1/facilities/madrid-01 \ -H "Authorization: Bearer $TOKEN" \ -d @centro.jsonRecibe los avisos
Comprueba la firma de cada uno antes de usarlo:
js// Qbox-Signature: t=1782456000,v1=5f3a… const ok = hmacSha256(secret, `${t}.${rawBody}`) === v1 && Date.now() / 1000 - t < 300;
Guías
- IntroducciónQué hace la API, lo común a todas sus operaciones y los primeros pasos.
- El entorno de pruebasCredenciales de pruebas, tu «Gestora de pruebas» y lo que puedes probar sin publicar nada.
- El permiso de la gestoraOAuth 2.0 con código de autorización y PKCE, desde Qbox.
- Publica tus centrosLos datos de cada centro, lo que comprobamos, la revisión y la lista de cada día.
- Tamaños, precios y trasterosLos tamaños del centro, el estado y el precio de cada trastero, y cada cambio al momento.
- El plano y las fotosEl SVG de cada planta, con el id de cada trastero, y las fotos del centro.
- Las solicitudesLas solicitudes de información y de lista de espera de los centros, en tu software.
- Los avisosQué llega, cómo se comprueba su firma y los reintentos.
- Alquiler onlineEl nivel 2: el cliente alquila en el portal y paga en la pasarela de la gestora, con lo que decide tu software.
- Errores y límitesCada error con su código, repetir sin duplicar y qué hacer con un 429.
- La certificaciónLas pruebas automáticas y la revisión de un centro de verdad, antes de producción.
- VersionesLo que cambia en cada versión y cómo avisamos.
Referencia de la API
OpenAPI 3.1, con cada ruta, sus campos y sus errores. Sale del mismo contrato que usa el portal.
Versiones
v1 · beta. Añadir campos u operaciones no rompe nada; lo que rompa algo va en una v2, con al menos seis meses de aviso. Lo último: el nivel 2, el alquiler online, con el pago en la pasarela de la gestora.
VersionesLa certificación del nivel 1
- Un centro completo, con su dirección y su punto
- Sus tamaños y sus trasteros, con su estado y su precio
- El plano, con todos sus trasteros
- La lista de cada día
- Un aviso, con su firma comprobada
- Un reintento tras un 429
Y la revisión de uno de tus centros de verdad.
La certificación¿Lo conectamos?
O escríbenos a team@findqbox.com.
Pide acceso