Skip to content
WorksBuddy Docs
API

Authentication

Authenticate WorksBuddy API requests with an API key or OAuth 2.0.

Authenticate every WorksBuddy API request with either an API key or an OAuth 2.0 access token, passed as a bearer token in the Authorization header.

Create a key

TODO: document where in the WorksBuddy dashboard to generate an API key.

Store it securely

Keep the key server side. Never expose it in client code.

Send it on every request

Pass the key as a bearer token in the Authorization header.

curl https://TODO_API_BASE_URL/TODO_RESOURCE \
  -H "Authorization: Bearer TODO_API_KEY"

Register an app

TODO: document how to register an OAuth client and obtain a client ID and secret.

Request an access token

TODO: document the authorization and token endpoints, scopes, and grant type.

Call the API

Send the returned access token as a bearer token in the Authorization header.

curl https://TODO_API_BASE_URL/TODO_RESOURCE \
  -H "Authorization: Bearer TODO_ACCESS_TOKEN"
TODO: document token lifetime, refresh flow, and key rotation.