내용으로 건너뛰기

시작하기

GitHub

설치

설치

Capgo의 AI-Assisted Setup을 사용하여 플러그인을 설치할 수 있습니다. AI 도구에 Capgo 기능을 추가하려면 다음 명령어를 사용하세요:

터미널 창
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

다음 명령어를 사용하여 다음 프롬프트를 사용하세요:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-social-login` plugin in my project.

만약 Manual Setup을 선호한다면, 플러그인을 설치하기 위해 다음 명령어를 실행하고 아래에 플랫폼별 지침을 따르세요:

  1. 패키지를 설치

    터미널 창
    npm install @capgo/capacitor-social-login
  2. 자연 프로젝트와 동기화

    터미널 창
    npx cap sync
  3. 앱 시작 시 초기화

    import { SocialLogin } from '@capgo/capacitor-social-login';
    await SocialLogin.initialize({
    google: {
    webClientId: 'your-google-web-client-id',
    iOSClientId: 'your-google-ios-client-id',
    iOSServerClientId: 'your-google-web-client-id',
    mode: 'online',
    },
    apple: {
    clientId: 'your-apple-service-id',
    useProperTokenExchange: true,
    useBroadcastChannel: true,
    },
    facebook: {
    appId: 'your-facebook-app-id',
    },
    twitter: {
    clientId: 'your-twitter-client-id',
    redirectUrl: 'myapp://oauth/twitter',
    },
    oauth2: {
    github: {
    appId: 'your-github-client-id',
    authorizationBaseUrl: 'https://github.com/login/oauth/authorize',
    accessTokenEndpoint: 'https://github.com/login/oauth/access_token',
    redirectUrl: 'myapp://oauth/github',
    scope: 'read:user user:email',
    pkceEnabled: true,
    },
    },
    });

코어 흐름 예시

코어 흐름 예시 섹션
await SocialLogin.login({
provider: 'google',
options: { scopes: ['profile', 'email'] },
});
await SocialLogin.login({
provider: 'oauth2',
options: {
providerId: 'github',
scope: 'read:user user:email',
},
});
const status = await SocialLogin.isLoggedIn({ provider: 'google' });
await SocialLogin.logout({ provider: 'google' });

인증 코드 및 리프레시

인증 코드 및 리프레시 섹션
// For providers that support this mode
const authCodeResult = await SocialLogin.getAuthorizationCode({ provider: 'google' });
await SocialLogin.refresh({ provider: 'google', options: {} as never });

고급 도우미

고급 도우미 섹션
const jwt = await SocialLogin.decodeIdToken({
idToken: 'eyJhbGciOi...',
});
const { date } = await SocialLogin.getAccessTokenExpirationDate({
accessTokenExpirationDate: Date.now() + 3600 * 1000,
});
const expired = await SocialLogin.isAccessTokenExpired({
accessTokenExpirationDate: Date.now() + 1000,
});
const active = await SocialLogin.isRefreshTokenAvailable({ refreshToken: 'a-token' });

제공자별 참고

제공자별 참고 섹션

구글 오프라인 모드

구글 오프라인 모드

google.mode: 'offline' 리턴 serverAuthCode 로그인에서

이 모드에서는 로그아웃, isLoggedIn, getAuthorizationCode, 및 refresh가 사용할 수 없습니다. serverAuthCode 백엔드 토큰 교환에만 사용하세요. SocialLogin.refresh() 앱에서 호출해야 하는 경우 google.mode: 'online' 애플

안드로이드의 단순한 설정을 위해 useProperTokenExchange: true Apple useBroadcastChannel: true 설정

OAuth2 웹 리다이렉트 흐름

OAuth2 웹 리다이렉트 흐름

사용 OAuth2LoginOptions.flow: 'redirect' 페이지에서 벗어나서 흐름을 위한 웹 플로우

동적 제공자 의존성

제목: 동적 제공자 의존성

특정 제공자를 포함하여 네이티브 앱 크기를 줄이려면 구성할 수 있습니다. 앱이 특정 제공자만 필요할 때 가장 유용합니다.

제공자 구성 추가하기 capacitor.config.ts:

import type { CapacitorConfig } from '@capacitor/cli';
const config: CapacitorConfig = {
appId: 'com.example.app',
appName: 'MyApp',
webDir: 'dist',
plugins: {
SocialLogin: {
providers: {
google: true,
facebook: true,
apple: true,
twitter: false,
},
logLevel: 1,
},
},
};
export default config;

제공자 값은 다음과 같습니다:

  • true: 제공자가 활성화되어 있고 네이티브 의존성이 패키징됩니다.
  • false: 제공자가 비활성화되어 있고 네이티브 의존성이 패키징되지 않습니다.

중요한 정보:

  • 변경된 제공자 구성 후 실행하세요. npx cap sync 제공자 구성이 제공되지 않으면 모든 제공자가
  • 과 같은 역방향 호환성을 위해 기본값이 됩니다. true 사용하는 제공자를 비활성화하면
  • 런타임 시 사용할 수 없게 됩니다. false 이 구성은 iOS 및 Android에만 영향을 주며 Web에는 영향을 주지 않습니다.
  • Android에서 Apple Sign-In은 OAuth를 사용하며 외부
  • Apple Sign-In on Android uses OAuth without external SDK dependencies.
  • Twitter/X uses standard OAuth 2.0 without external SDK dependencies.

의존성을 사용하지 않습니다.

plugins: {
SocialLogin: {
providers: {
google: true,
facebook: false,
apple: true,
twitter: false,
},
},
}

If you are using Getting Started to plan authentication and account flows, connect it with Using @capgo/capacitor-social-login for the native capability in Using @capgo/capacitor-social-login @capgo/capacitor-social-login for the implementation detail in @capgo/capacitor-social-login @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, and 2단계 인증 2단계 인증 구현에 대한 세부 정보입니다.