mirror
/
funkwhale
kopia lustrzana https://dev.funkwhale.audio/funkwhale/funkwhale
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
funkwhale/api
Historia
jo 4fbef50d71 chore: add flake8 pre-commit hook 
Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2178>
 		2022-11-23 07:32:43 +00:00
..
compose/django feat(api/Docker): automatically run migrations on container start 2022-07-25 20:59:30 +00:00
config Fix setting ASGI http protocol handler 2022-11-12 18:15:48 +00:00
funkwhale_api chore: clean files using pre-commit 2022-11-22 14:30:01 +00:00
tests chore: clean files using pre-commit 2022-11-22 14:30:01 +00:00
.coveragerc Omit coverage of CustomAutoSchema 2022-09-27 09:30:26 +00:00
.dockerignore Cleanup Gitlab CI and Dockerfiles 2022-07-11 20:20:16 +00:00
.pylintrc chore: clean files using pre-commit 2022-11-22 14:30:01 +00:00
Dockerfile fix(api/Dockerfile): use psycopg2 from alpine repository 2022-11-22 22:49:30 +01:00
Readme.md ci: scan for broken links 2022-11-22 20:52:06 +00:00
install_os_dependencies.sh See #542: ensure install_os_dependencies.sh is runnable from anywhere 2018-10-01 19:16:48 +02:00
manage.py chore: clean files using pre-commit 2022-11-22 14:30:01 +00:00
poetry.lock Update dependency sentry-sdk to v1.11.1 2022-11-23 02:04:40 +00:00
pyproject.toml Update dependency sentry-sdk to v1.11.1 2022-11-23 02:04:40 +00:00
setup.cfg chore: add flake8 pre-commit hook 2022-11-23 07:32:43 +00:00

Readme.md

Funkwhale API

This is the Funkwhale API. Check out our API explorer for interactive documentation.

OAuth Authentication

Funkwhale uses the OAuth authorization grant flow for external apps. This flow is a secure way to authenticate apps that requires a user's explicit consent to perform actions. You can use our demo server at https://demo.funkwhale.audio for testing purposes.

To authenticate with the Funkwhale API:

  1. Create an application by sending a POST request to api/v1/oauth/apps. Include your scopes and redirect URI (use urn:ietf:wg:oauth:2.0:oob to get an authorization code you can copy)
  2. Send an authorization request to the /authorize endpoint to receive an authorization code
  3. Request an access token from /api/v1/oauth/token
  4. Use your access token to authenticate your calls with the following format: Authorization: Bearer <token>
  5. Refresh your access token by sending a refresh request to /api/v1/oauth/token

For more detailed instructions, see our API authentication documentation.

Application token authentication

If you have an account on your target pod, you can create an application at /settings/applications/new. Once you authorize the application you can retrieve an access token. Use your access token to authenticate your calls with the following format: Authorization: Bearer <token>

Rate limiting

Funkwhale supports rate-limiting as of version 0.2.0. Pod admins can choose to rate limit specific endpoints to prevent abuse and improve the stability of the service. If the server drops a request due to rate-limiting, it returns a 429 status code.

Each API call returns HTTP headers to pass the following information:

  • What was the scope of the request (X-RateLimit-Scope)
  • What is the rate-limit associated with the request scope (X-RateLimit-Limit)
  • How many more requests in the scope can be made within the rate-limit timeframe (X-RateLimit-Remaining)
  • How much time does the client need to wait to send another request (Retry-After)

For more information, check our rate limit documentation

Resources

For more information about API usage, refer to our API documentation.