QuickBuild
L'outil QuickBuild est un puissant assistant conçu pour accélérer votre intégration avec SyAuth. Il vous guide à travers un processus de configuration étape par étape et génère un fichier de configuration d'environnement complet prêt pour votre application.
Vue d'ensemble
QuickBuild gère la complexité de la configuration de :
- Clients OAuth
- Tokens API
- Fournisseurs d'identité externes (Connexion Sociale)
- URIs de redirection
- Scopes
À la fin du processus, vous recevez un extrait de fichier .env.local prêt à l'emploi que vous pouvez déposer directement dans votre projet.
Utiliser QuickBuild
Pour accéder à QuickBuild, allez sur la page Accueil du Tableau de bord et localisez la carte QuickBuild (en bleu) dans la section Accès Rapide. Cliquez sur la carte pour lancer l'assistant.
Étape 1 : Sélection de la Technologie
Choisissez votre stack technologique. Actuellement supporté :
- Next.js : Support complet pour Next.js App Router et Pages Router.
- Django : Intégration transparente avec le paquet
django-syauth. - Node.js (Bientôt disponible)
Étape 2 : Sélection du Cas d'Usage
Sélectionnez comment vous souhaitez intégrer SyAuth :
- Intégration App (SDK) : Idéal pour les applications web standard. Utilise les SDKs
@syauth/nextjsoudjango-syauthpour un flux d'authentification transparent. - Page de Connexion Personnalisée : Idéal si vous construisez une UI de connexion personnalisée qui interagit directement avec l'API SyAuth.
Étape 3 : Informations de Base
Entrez les détails principaux pour votre configuration :
- Nom de l'Entreprise : Le nom de votre organisation.
- Contact Admin : L'email principal pour les notifications administratives.
- Nom de l'Application : (Optionnel) nom spécifique pour cette intégration d'application.
Étape 4 : Méthodes d'Authentification
Choisissez quelles stratégies d'authentification activer :
- Email & Mot de passe : Authentification locale standard.
- OAuth / OpenID Connect : Requis pour les connexions sociales et le support du protocole standard.
- URIs de Redirection : Où les utilisateurs sont envoyés après la connexion (ex :
http://localhost:3000/auth/callback). - Scopes Autorisés : Permissions demandées (défaut :
openid profile email).
- URIs de Redirection : Où les utilisateurs sont envoyés après la connexion (ex :
Étape 5 : Fournisseurs Externes
Configurez les fournisseurs de connexion sociale en une seule fois. Vous pouvez activer et configurer :
- GitHub
Pour chaque fournisseur sélectionné, vous pouvez directement saisir le Client ID et le Client Secret. QuickBuild définit par défaut l'URL de callback vers le endpoint standard SyAuth :
https://api.syauth.com/e/v1/oauth/{provider}/callback/
Étape 6 : Révision & Construction
Vérifiez le résumé de votre configuration. Lorsque vous cliquez sur Construire, SyAuth va :
- Utiliser l'Espace de travail actuellement actif dans votre tableau de bord.
- Créer/Configurer le Client OAuth.
- Générer les Tokens API nécessaires.
- Configurer tous les Fournisseurs Externes sélectionnés.
Résultat
Une fois la construction terminée, QuickBuild présente un bloc de configuration adapté à votre cas d'usage sélectionné.
Exemple de Configuration Next.js (.env.local) :
# SyAuth SDK Configuration
NEXT_PUBLIC_SYAUTH_API_URL=https://api.syauth.com/e/v1
NEXT_PUBLIC_SYAUTH_CLIENT_ID=...
NEXT_PUBLIC_SYAUTH_API_KEY=...
NEXT_PUBLIC_SYAUTH_REDIRECT_URI=http://localhost:3000/auth/callback
NEXT_PUBLIC_SYAUTH_SCOPES=openid,profile,email
NEXT_PUBLIC_REDIRECT_AFTER_LOGIN=/dashboard
Exemple de Configuration Django (.env) :
# SyAuth Django Configuration
SYAUTH_API_URL=https://api.syauth.com/e/v1
SYAUTH_CLIENT_ID=...
SYAUTH_API_KEY=...
SYAUTH_REDIRECT_URI=http://localhost:8000/auth/callback/
SYAUTH_SCOPES=openid profile email
Prochaines Étapes
- Copiez ou Téléchargez la configuration.
- Collez-la dans le fichier
.env.localde votre projet. - Lancez votre serveur de développement.
Note de Sécurité : Cette configuration contient des secrets potentiels sensibles (selon le flux). Assurez-vous de ne jamais commiter les fichiers
.envdans le contrôle de version.