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.
Approach 1: API Keys
Consider approach 1: api keys. 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.
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.
Where API keys break down
Where API keys break down deserves its own treatment. 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.
- 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
When to use API keys
That brings us to when to use api keys. 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.
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.
What implementing API keys actually involves
What implementing API keys actually involves deserves its own treatment. 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.
Make the boundary explicit.
Approach 2: Token files
Approach 2: Token files deserves its own treatment. 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.
The advantages over API keys
Consider the advantages over api keys. 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.
Where token files break down
Where token files break down 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.
Where this leaves us
If there is one thing worth taking away, it is that the expensive decisions are the ones made implicitly. Making them on purpose costs an afternoon.
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.