docs: add direct HTTP quickstart#57
Merged
Merged
Conversation
Add docs/direct-http-quickstart.md: an end-to-end curl walkthrough of the direct HTTP integration path (login -> ephemeral token -> email OTP -> access/refresh tokens -> authenticated call -> refresh). Request and response shapes are taken from the route schemas, including that the refresh token is sent in the Authorization header and that refresh rotates the token. Link it from the README direct-HTTP entry and add it to the docs gitignore allowlist.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The docs pointed to a "Direct HTTP APIs (advanced)" integration path but never showed it. Integrators not using the SDKs had to reverse-engineer the login flow from route files.
This adds docs/direct-http-quickstart.md: an end-to-end
curlwalkthrough of the email-OTP login flow:POST /login-> ephemeral token +loginMethodsGET /otp/generate-login-email-otp(ephemeral Bearer) -> OTP, with external-delivery mode for headless retrievalPOST /otp/verify-login-email-otp-> access + refresh tokensGET /users/me(access Bearer)POST /refresh-> rotated tokensEvery request and response shape is taken directly from the route schemas, including two things that are easy to get wrong:
Authorizationheader, not the body.It also calls out that external delivery requires a service token in production, and that direct integration is the advanced path (token custody notes link to the Deployment Topology section).
Notes
docs/direct-http-quickstart.mdto thedocs/gitignore allowlist.architecture.md#deployment-topology, which is added in docs: define trusted server adapter and add deployment topology #56; the anchor resolves once that merges.