A design is a set of bets. Writing down which bets you are making — and what would have to be true for them to be wrong — costs an afternoon and saves a rewrite.
This piece walks through how we think about it at Paycux, what we have changed our minds about, and where the sharp edges are.
What you are building
What you are building deserves its own treatment. Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Choosing the right credential shape
Consider choosing the right credential shape. Measure before you optimise, then measure the thing users feel rather than the thing that is easy to instrument. A p50 that looks fine while the p99 is unusable is a reporting failure, not a performance one.
Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
- Name the boundary before you cross it
- Measure what users feel, not what is easy to instrument
- Make every retried operation idempotent
- Write down the assumption that would invalidate the design
Setting up permissions
That brings us to setting up permissions. Measure before you optimise, then measure the thing users feel rather than the thing that is easy to instrument. A p50 that looks fine while the p99 is unusable is a reporting failure, not a performance one.
Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Adding the API keys widget to your settings page
Adding the API keys widget to your settings page is where this gets concrete. Idempotency is not a nice-to-have in any system with retries. Key on an identifier the caller supplies, store the outcome, and return the same answer to the same key rather than doing the work twice.
Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Idempotency is not a nice-to-have in any system with retries.
Protecting your API routes
That brings us to protecting your api routes. Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Idempotency is not a nice-to-have in any system with retries. Key on an identifier the caller supplies, store the outcome, and return the same answer to the same key rather than doing the work twice.
What the validation response gives you
What the validation response gives you is where this gets concrete. Idempotency is not a nice-to-have in any system with retries. Key on an identifier the caller supplies, store the outcome, and return the same answer to the same key rather than doing the work twice.
Make the boundary explicit. When one part of the system can only talk to another through a named interface, you can change either side without a meeting; when it cannot, every change becomes a negotiation.
Testing with real keys
Testing with real keys is where this gets concrete. Measure before you optimise, then measure the thing users feel rather than the thing that is easy to instrument. A p50 that looks fine while the p99 is unusable is a reporting failure, not a performance one.
Measure before you optimise, then measure the thing users feel rather than the thing that is easy to instrument. A p50 that looks fine while the p99 is unusable is a reporting failure, not a performance one.
Where this leaves us
The pattern repeats across every system we have looked at: the hard part is not the mechanism, it is keeping the mechanism honest as the surrounding assumptions change.
If you are working through the same problem and want to compare notes, the docs cover the mechanics and the console shows the behaviour on your own data.
Everything here, already built
Sign-in, enterprise SSO, directory provisioning, roles and an audit trail behind one API. Start with the quickstart and have a working sign-in this afternoon.