Design an Idiomatic REST + Webhooks API for a Logistics SaaS
Overview
What this challenge is about.
Read the team's draft + the public APIs of 3 reference logistics platforms (anonymized, briefing pack provided). Author a 5-page API design guideline covering URL structure (nouns + plural), ID format (ULID), pagination (cursor + page-size), error envelope (RFC 7807 problem+json), and versioning (URL major version). Redesign the 12 core resources (Shipment, Container, BookingRequest, etc.) into a single OpenAPI 3.1 specification. Design the webhook subsystem covering signed payloads (HMAC-SHA256), retry policy (exponential with cap), delivery guarantees (at-least-once + idempotency keys), and a replay endpoint. Deliver guideline, OpenAPI spec, webhook design document, and a 2-page DX (developer experience) self-review from a hypothetical integrator's perspective.
The Brief
What you'll do, and what you'll demonstrate.
Author an API design guideline, redesign 12 resources, and design a production-grade webhook subsystem for a logistics SaaS launching a public API.
Earning criteria — what you'll demonstrate
- Author an API guideline that survives the team's first 12 resources
- Design a webhook subsystem with at-least-once + idempotency
- Trade off URL versioning vs header versioning with evidence
- Self-critique a public API before integrators do
Program Fit
Where this fits in your program.
Sharpens the same skills your degree expects you to demonstrate.
Skills
Skills you'll demonstrate.
Each one shows up on your verified credential.
Careers
Roles this prepares you for.
Real titles. Real skill bridges. Pick the one closest to your trajectory.
Career mappings coming soon.