Skip to content

Document User-Agent header requirement for hosted API #2505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
robzolkos wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

Document User-Agent header requirement for hosted API #2505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ To authenticate a request using your access token, include it in the `Authorizat
curl -H "Authorization: Bearer put-your-access-token-here" -H "Accept: application/json" https://app.fizzy.do/my/identity
```

> [!NOTE]
> When using the hosted version at app.fizzy.do, API requests must include a descriptive `User-Agent` header (e.g., `User-Agent: MyApp/1.0`).
> Requests using default scripting user agents like `Python-urllib` may be blocked before reaching the API. Self-hosted instances may not have this requirement.
### Magic Link Authentication

For native apps, you can authenticate users via magic links. This is a two-step process:
Expand Down