Getting Started

Installazione

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

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

Usa poi il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

1. Installa il pacchetto

   bun add @capgo/capacitor-passkey

2. Sincronizza progetti nativi

   bunx cap sync

3. Aggiungi la configurazione del plugin

   import type { CapacitorConfig } from '@capacitor/cli';
   
   const config: CapacitorConfig = {
     appId: 'app.capgo.passkey.example',
     appName: 'My App',
     webDir: 'dist',
     plugins: {
       CapacitorPasskey: {
         origin: 'https://signin.example.com',
         autoShim: true,
         domains: ['signin.example.com'],
       },
     },
   };
   
   export default config;

4. Installa il shim durante l'avvio

   import { CapacitorPasskey } from '@capgo/capacitor-passkey';
   
   await CapacitorPasskey.autoShimWebAuthn();

5. Mantieni il flusso WebAuthn normale

   const registration = await navigator.credentials.create({
     publicKey: registrationOptions,
   });
   
   const authentication = await navigator.credentials.get({
     publicKey: requestOptions,
   });

Cosa fa la configurazione del plugin

La configurazione viene letta da plugins.CapacitorPasskey in capacitor.config.*.

• origin: origine HTTPS primaria utilizzata dal shim e diretto API
• domains: hostnames di origine di dipendenza aggiuntivi da integrare nella configurazione nativa durante la sincronizzazione
• autoShim: predefinito su true e controlla la funzione di hook di auto-configurazione nativa cap sync e controlla la funzione di hook di auto-configurazione nativa

Cosa sincronizza per te

Quando esegui bunx cap sync, il plugin aggiorna il progetto host nativo generato:

• iOS: autorizzazioni per dominio associato e autorizzazioni Xcode quando necessario
• Android: asset_statements metadati e il risorsa generata utilizzata dal manifesto

L'hook non pubblica i file di trust del tuo sito per te. Hai ancora bisogno di ospitare:

• https://your-domain/.well-known/apple-app-site-association
• https://your-domain/.well-known/assetlinks.json

Guida per piattaforma

Configurazione iOS

Domini associati e apple-app-site-association.

Configurazione Android

Digital Asset Links e assetlinks.json.

Note sul backend

Validazione dell'origine e avvertimenti per Android.

Continua da Inizia

Se stai utilizzando Inizia per pianificare l'autenticazione e le flussi di account, connettilo con Utilizza @capgo/capacitor-passkey per la capacità nativa in Utilizza @capgo/capacitor-passkey, @capgo/capacitor-social-login For il dettaglio di implementazione in @capgo/capacitor-login-social, @capgo/capacitor-passkey For il dettaglio di implementazione in @capgo/capacitor-passkey, @capgo/capacitor-biometria-nativa For il dettaglio di implementazione in @capgo/capacitor-biometria-nativa, e Autenticazione a due fattori For il dettaglio di implementazione in Autenticazione a due fattori.