Qbox
Documentation

Getting started

The test environment

Test credentials, your “Test operator” and what you can try without publishing anything.

With test credentials (qt_test_…) you use the same API, with the same checks, without publishing anything on the portal.

Your “Test operator”

Every software has its own, which isn't a real operator. You give it access with the same flow as a real one (see The operator's permission), signing in to Qbox with your account. In testing, return URLs can be http://localhost.

What you can do from your area

  • Operators: how each centre you send would look on the portal, with its photos, its floors and its sizes, and what it's missing.
  • Simulate the review: what the team would decide (publish it, return it with its reasons or withdraw it). You get the facility.reviewed webhook.
  • A test request: a made-up one, for one of your centres. You get it with lead.created.
  • Webhooks: the signature test, each delivery with its response, and “Retry”.
  • Log: every request from the last 30 days, with its errors field by field.

A test 429

To try your retries, send the Qbox-Simulate: rate_limited header in testing: the response is a 429 with Retry-After: 2. Wait that long and repeat the same request with the same Idempotency-Key.

HTTP
PUT /connect/v1/facilities/madrid-01/unit-types
Authorization: Bearer <test token>
Idempotency-Key: 5b1d0c3e-8f6a-4c2e-9d1b-7a0e2f4c6b11
Qbox-Simulate: rate_limited

HTTP/1.1 429 Too Many Requests
Retry-After: 2

Once you pass every certification test, you request it from your area: Certification.

Questions? Write to us at team@findqbox.com.