tweakcn Documentation

tweakcn uses the standard OAuth 2.0 Authorization Code flow. PKCE is supported for public clients (SPAs, mobile apps) by adding code_challenge and code_challenge_method=S256 to the authorization request, and providing the code_verifier during the token exchange.

1. Redirect the user to authorize

Send the user to: GET https://tweakcn.com/api/oauth/authorize?client_id=CLIENT_ID&redirect_uri=https://myapp.com/callback&response_type=code&scope=themes:read profile:read&state=RANDOM_STRING

Upon successful sign-in, the user is redirected to your redirect_uri with a code parameter.

2. Exchange the code for tokens

Exchange the authorization code for an access token and refresh token using a POST request:

3. Call the API

Use the access_token as a Bearer token in the Authorization header.

4. Refresh tokens

When the access token expires (typically after 1 hour), use the refresh_token to obtain a new pair.

5. Revoke tokens

Revoke an access or refresh token when it is no longer needed.

# 1. Exchange code for tokens
curl -X POST https://tweakcn.com/api/oauth/token \
  -d grant_type=authorization_code \
  -d client_id=CLIENT_ID \
  -d client_secret=CLIENT_SECRET \
  -d code=AUTH_CODE \
  -d redirect_uri=https://myapp.com/callback

# 2. Call the API
curl https://tweakcn.com/api/v1/themes \
  -H "Authorization: Bearer ACCESS_TOKEN"

# 3. Refresh tokens
curl -X POST https://tweakcn.com/api/oauth/token \
  -d grant_type=refresh_token \
  -d client_id=CLIENT_ID \
  -d client_secret=CLIENT_SECRET \
  -d refresh_token=REFRESH_TOKEN

# 4. Revoke tokens
curl -X POST https://tweakcn.com/api/oauth/revoke \
  -d token=ACCESS_OR_REFRESH_TOKEN

tweakcn can be used as a provider within the Better Auth genericOAuth plugin. You must configure the authorizationUrl, tokenUrl, and userInfoUrl correctly on the server, and use genericOAuthClient on the client side.

// server
import { genericOAuth } from "better-auth/plugins";

export const auth = betterAuth({
  plugins: [
    genericOAuth({
      config: [
        {
          providerId: "tweakcn",
          clientId: process.env.TWEAKCN_CLIENT_ID,
          clientSecret: process.env.TWEAKCN_CLIENT_SECRET,
          authorizationUrl: "https://tweakcn.com/api/oauth/authorize",
          tokenUrl: "https://tweakcn.com/api/oauth/token",
          userInfoUrl: "https://tweakcn.com/api/oauth/userinfo",
          scopes: ["themes:read", "profile:read"],
        },
      ],
    }),
  ],
});

// client
import { genericOAuthClient } from "better-auth/client/plugins";

const authClient = createAuthClient({
  plugins: [genericOAuthClient()],
});

await authClient.signIn.oauth2({
  providerId: "tweakcn",
  callbackURL: "/dashboard",
});