Flagship service
REST API design review
For product teams about to expose a versioned HTTP API to external integrators — or teams recovering from a painful partner onboarding.
Reserve a review window
Who it is for
Backend leads and staff engineers at B2B software companies, internal platform teams publishing APIs to branches, and CTOs who need an independent opinion before a major version ships.
Result you receive
A PDF report (typically 25–45 pages) plus a CSV of findings importable into Jira or Linear. Each finding includes severity, affected routes, example request/response, and a suggested fix. A live 90-minute readout with your team is included.
Scope included
- Resource naming, nesting depth, and collection patterns
- HTTP methods, status codes, and idempotency for unsafe operations
- Pagination, filtering, and sorting consistency
- Error envelope structure and machine-readable codes
- Versioning strategy and deprecation headers
- Authentication and authorisation boundaries at the HTTP layer
- OpenAPI 3.x accuracy versus actual behaviour (when a staging URL is provided)
Out of scope unless quoted
- Penetration testing or infrastructure hardening
- Implementing fixes in your codebase
- GraphQL or gRPC-only APIs (we can refer you to associates)
Process and timeline
- Kickoff call (30 min) — agree version boundary and partner personas
- Materials intake — OpenAPI files, Postman collections, or repo read access
- Silent review (3–4 days) — no meetings unless a blocking question arises
- Readout and Q&A (90 min)
- Report delivery within 24 hours after readout
Standard turnaround: five business days from complete materials. See rates.
Preparation
Send your latest OpenAPI export, a list of top five partner use cases, and any known pain tickets from integrators. Staging credentials with read-only test data speed up contract verification.
Provider
Led by Thabo Molefe, principal consultant at APIQuartz (Pty) Ltd. Delivered remotely or from Durban; on-site readouts in Gauteng or Western Cape incur travel at cost.