Saltar al contenido

Primeros pasos

GitHub

Puedes usar nuestro setup asistido por IA para instalar el plugin. Añade las skills de Capgo a tu herramienta de IA con el siguiente comando:

Ventana de terminal
npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Luego usa el siguiente prompt:

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

Si prefieres la configuración manual, instala el plugin ejecutando estos comandos y sigue las instrucciones de cada plataforma:

  1. Instala el paquete

    Ventana de terminal
    bun add @capgo/capacitor-social-login
  2. Sincroniza con proyectos nativos

    Ventana de terminal
    bunx cap sync
  3. Inicializar en el arranque de la app

    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,
    },
    },
    });
  • Un solo paquete para Google, Apple, Facebook, Twitter/X y proveedores personalizados de OAuth2 u OIDC.
  • Android Google Sign-In mediante Credential Manager en lugar de plugins de la comunidad obsoletos.
  • Proveedores estilo Ionic Auth Connect a través de la capa de compatibilidad documentada.
  • Apps que deben compartir el login code entre las builds móviles y web.
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' devuelve serverAuthCode desde login. En este modo, logout, isLoggedIn, getAuthorizationCode y refresh no están disponibles.

Usa serverAuthCode solo como entrada para el intercambio de token en tu backend. Si necesitas llamar a SocialLogin.refresh() en la app, usa google.mode: 'online' en su lugar.

Configurar useProperTokenExchange: true para un manejo estricto de tokens y useBroadcastChannel: true para una configuración simplificada en Android.

Usa OAuth2LoginOptions.flow: 'redirect' para flujos web que navegan fuera de la página.

Puedes configurar qué proveedores incluir para reducir el tamaño de la app nativa. Esto es más útil cuando tu app solo necesita proveedores específicos.

Añade la configuración del proveedor a 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;

Los valores de provider significan:

  • true: el provider está habilitado y sus dependencias nativas están incluidas en el bundle.
  • false: el provider está deshabilitado y sus dependencias nativas no están incluidas en el bundle.

Detalles importantes:

  • Ejecuta bunx cap sync después de cambiar la configuración del provider.
  • Si no se proporciona configuración de provider, todos los providers usan por defecto true por compatibilidad hacia atrás.
  • Deshabilitar un provider con false lo hace no disponible en tiempo de ejecución, incluso si ese provider solo usa APIs del sistema.
  • Esta configuración solo afecta a iOS y Android; no afecta a Web.
  • Apple Sign-In en Android usa OAuth sin dependencias externas de SDK.
  • Twitter/X usa OAuth 2.0 estándar sin dependencias externas de SDK.

Para incluir solo Google Sign-In y Apple Sign-In:

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

Si estás usando Primeros pasos para planificar los flujos de autenticación y de cuenta, conéctalo con Uso de @capgo/capacitor-social-login para la capacidad nativa en el uso de @capgo/capacitor-social-login, @capgo/capacitor-social-login para los detalles de implementación en @capgo/capacitor-social-login, @capgo/capacitor-passkey para el detalle de implementación en @capgo/capacitor-passkey, @capgo/capacitor-native-biometric para el detalle de implementación en @capgo/capacitor-native-biometric, y Autenticación de dos factores para el detalle de implementación en la autenticación de dos factores.