Class Dribbble

Provides an OAuth 2.0 client for interacting with Dribbble's authentication and token APIs.

Remarks

This class allows creating authorization URLs, validating authorization codes, and generating secure state strings.

Example

const dribbble = new Dribbble({
  clientId: "your-client-id",
  clientSecret: "your-client-secret",
  redirectURI: "https://your-redirect-uri.com"
});

const state = dribbble.generateState();
const authURL = dribbble.createAuthorizationURL(state, ["public"]);
console.log(authURL);

// After receiving the authorization code:
const authResponse = await dribbble.validateAuthorizationCode("auth-code");
console.log(authResponse.accessToken);

Constructors

constructor

Methods

createAuthorizationURL generateState validateAuthorizationCode

Constructors

constructor

Methods

createAuthorizationURL

  • createAuthorizationURL(state: string, scopes: string[]): string

  • Generates an authorization URL for Dribbble's OAuth 2.0 flow.

    Parameters

    • state: string

      A unique string to maintain state between the request and callback.

    • scopes: string[]

      An array of scopes to request from the user.

    Returns string

    The authorization URL for Dribbble.

    Example

    const state = dribbble.generateState();
    const authURL = dribbble.createAuthorizationURL(state, ["public", "write"]);
    console.log(authURL);

generateState

  • generateState(): string

  • Generates a cryptographically secure state string for OAuth 2.0.

    Returns string

    A Base64-encoded state string.

    Example

    const state = dribbble.generateState();
    console.log(state); // Use this as the `state` parameter in your auth request.

validateAuthorizationCode

  • validateAuthorizationCode(code: string): Promise<DribbbleAuthResponse>

  • Validates an authorization code and retrieves an access token from Dribbble.

    Parameters

    • code: string

      The authorization code received from Dribbble.

    Returns Promise<DribbbleAuthResponse>

    A promise that resolves to a DribbbleAuthResponse containing the access token and other details.

    Example

    const authResponse = await dribbble.validateAuthorizationCode("auth-code");
    console.log(authResponse.accessToken);

Settings

Member Visibility

On This Page

Constructors
Methods