View Issue Details

IDProjectCategoryView StatusLast Update
0010575Talerdocumentationpublic2025-11-10 21:35
Reporterhtgoebel Assigned To 
PrioritynormalSeverityfeatureReproducibilityhave not tried
Status newResolutionopen 
Summary0010575: Enhance documentation for Authentication
DescriptionThe section "Authentication" in the merchant backend documentations currently is confusing and would befit from some improvements. It is confusing since it writes about "the /private/auth/ API" but not about private endpoints in general, Also the description about how to obtain a "login token" is not obvious.

- Don't mention "the /private/auth/ API" here since the authentication schemes apply to all endpoints.
- Deprecated method behind current ones.
- Mention Basic Auth (and that it is only valid for /private/auth and /private/token)
- Deprecated "token", last sentence: "login token", but this term was not used before.
- Non-deprected "token" uses "bearer token", "authentication token"
- How to retrieve a token should be more prominent. Since this is the only non-deprected way of authentication, I suggest putting this into (short) section of its own.
- "A login token is commonly only valid for a limited period of time": Mention that this period can be defined when retrieving a token.
- Endpoint releated to authentication (/private/auth, /private/token) should go into this section. At least they should go into a separrate section "Authentication Management" in "Instance Management" and not be hidden under "Setting up instances".
TagsNo tags attached.

Activities

There are no notes attached to this issue.

Issue History

Date Modified Username Field Change
2025-11-10 21:35 htgoebel New Issue