The Qbox API for self-storage software

Get started in three steps

1. 1

   Get your credentials

   Once we accept your request, your test ones. With them, your software's token:

   curlCopy

   curl -X POST https://api.findqbox.com/connect/oauth/token \
     -d grant_type=client_credentials \
     -d client_id=$CLIENT_ID \
     -d client_secret=$CLIENT_SECRET

2. 2

   Send a centre

   With the operator's permission, its full address, its location and its opening hours:

   curlCopy

   curl -X PUT https://api.findqbox.com/connect/v1/facilities/madrid-01 \
     -H "Authorization: Bearer $TOKEN" \
     -d @centre.json

3. 3

   Receive webhooks

   Check the signature of each one before using it:

   jsCopy

   // Qbox-Signature: t=1782456000,v1=5f3a…
   const ok = hmacSha256(secret, `${t}.${rawBody}`) === v1
     && Date.now() / 1000 - t < 300;

Guides

• IntroductionWhat the API does, what all its operations share and your first steps.
• The test environmentTest credentials, your “Test operator” and what you can try without publishing anything.
• The operator's permissionOAuth 2.0 with authorization code and PKCE, from Qbox.
• Publish your centresThe details of each centre, what we check, the review and the daily list.
• Sizes, prices and unitsThe centre's sizes, each unit's status and price, and every change in real time.
• Floor plan and photosEach floor's SVG, with every unit's id, and the centre's photos.
• RequestsThe centres' information and waiting-list requests, in your software.
• WebhooksWhat arrives, how to check its signature and the retries.
• Online rentalLevel 2: customers rent on the portal and pay on the operator's gateway, with what your software decides.
• Errors and limitsEvery error with its code, safe retries and what to do with a 429.
• CertificationThe automatic tests and the review of a real centre, before production.
• VersionsWhat changes in each version and how we give notice.