Getting Started

Installazione

Puoi utilizzare la nostra configurazione assistita da AI per installare il plugin. Aggiungi le Capgo competenze al tuo strumento AI utilizzando il seguente comando:

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

Poi utilizza la seguente richiesta:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo platform sotto:

1. Installa il pacchetto

   npm install @capgo/capacitor-social-login

2. Sincronizza con progetti nativi

   npx cap sync

3. Avvia in avvio dell'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,
       },
     },
   });

Esempi di flusso di base

Accedi

await SocialLogin.login({
  provider: 'google',
  options: { scopes: ['profile', 'email'] },
});

await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'github',
    scope: 'read:user user:email',
  },
});

Sottosezione intitolata “Accedi”

const status = await SocialLogin.isLoggedIn({ provider: 'google' });
await SocialLogin.logout({ provider: 'google' });

Codici di autenticazione e ricarica

// For providers that support this mode
const authCodeResult = await SocialLogin.getAuthorizationCode({ provider: 'google' });
await SocialLogin.refresh({ provider: 'google', options: {} as never });

Aiuti avanzati

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' });

Note specifiche del provider

Modalità offline di Google

google.mode: 'offline' ritorna serverAuthCode da login. In questo modo logout, isLoggedIn, getAuthorizationCode, e refresh non sono disponibili.

Usa serverAuthCode solo come input per l'exchange del token nel tuo backend. Se hai bisogno di chiamare SocialLogin.refresh() al posto di google.mode: 'online' Apple

Apple

Set useProperTokenExchange: true per il trattamento del token rigoroso e useBroadcastChannel: true per la configurazione semplificata di Android.

flusso di reindirizzamento OAuth2 web

Usa OAuth2LoginOptions.flow: 'redirect' per flussi web che si spostano via dalla pagina.

Dipendenze di provider dinamiche

Puoi configurare quali provider includere per ridurre la dimensione dell'app nativa. Ciò è più utile quando il tuo app ha bisogno di provider specifici.

Aggiungi configurazione del provider 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;

Il valore del provider significa:

• true: il provider è abilitato e le sue dipendenze native sono incorporate.
• false: il provider è disabilitato e le sue dipendenze native non sono incorporate.

Dettagli importanti:

• Esegui npx cap sync Dopo aver modificato la configurazione del provider.
• If no provider configuration is supplied, all providers default to true Disabilitando un provider con
• Disabilitando un fornitore con false Questa configurazione influisce solo su iOS e Android; non influisce su Web.
• Apple Sign-In su Android utilizza OAuth senza dipendenze esterne __CAPGO_KEEP_0__.
• Twitter/X utilizza OAuth 2.0 standard senza dipendenze esterne SDK.
• Twitter/X utilizza OAuth 2.0 standard senza dipendenze esterne SDK.

Per includere solo Google Sign-In e Apple Sign-In:

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

Documentazione correlata

• Panoramica delle integrazioni
• Integrazione di Better Auth
• Fornitori OAuth2 e OIDC
• Troubleshooting
• Manifesto sulla privacy e gestori di URL iOS
• Migrare da Ionic Auth Connect
• Guida di migrazione per Social Login Auth Connect
• Migrare provider legacy
• Soluzione di migrazione per plugin Ionic enterprise

Continua da qui da Inizia

Se stai utilizzando Getting Started per pianificare l'autenticazione e le flussi di account, connettilo con Utilizzare @capgo/capacitor-login-social per la capacità nativa in Utilizzare @capgo/capacitor-login-social Utilizzare @capgo/capacitor-login-social per il dettaglio di implementazione in @capgo/capacitor-login-social Utilizzare @capgo/capacitor-passkey per il dettaglio di implementazione in @capgo/capacitor-passkey Utilizzare @capgo/capacitor-biometric-nativo per il dettaglio di implementazione in @capgo/capacitor-biometric-nativo, e L'autenticazione a due fattori per i dettagli di implementazione nella due-factor authentication.