Repository navigation
docs: state the API base URL - #89
Merged
Merged
Conversation
Every tutorial gives endpoint paths without a host, and no page named one, so an integrator had no way to learn where to send requests short of asking. The page about calling endpoints now opens with the base URL and an example of joining it to a documented path. Signed-off-by: Dmitrii Creed <creeed22@gmail.com>
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.
Why
A PryvX engineer integrating against the API asked which base URL to use, and the documentation had no answer. Every tutorial and every API specification page gives paths only, such as
POST /auth/api/v1/authentication-management/session, and no page states the host they hang off. The only place a host appears at all is the public test environment page.What changed
getting-started/calling-api-endpoints.mdnow states the base URL,https://backend.fraudintelligencelimited.com, and shows one worked example of joining it to a documented path.Verified against production: a request to that host reaches the auth service and is validated. The
api.subdomain some clients assume does not resolve.Noted separately, not fixed here
The public test environment page documents
app.stage1.fraudintelligencelimited.comandbackend.stage1.fraudintelligencelimited.com. Neither hostname resolves any more, so a reader following that page gets DNS failures. Whether to restore the environment or withdraw the page is a product decision, so this PR leaves it alone.