story-research-zapwall/docs/rizful-api-setup.md

Configuration de l'API Rizful.com

Auteur : Équipe 4NK

Obtention de la clé API Rizful

Étape 1 : Créer un compte Rizful

1. Accédez à Rizful.com
2. Cliquez sur "Sign Up" ou "Créer un compte"
3. Remplissez le formulaire d'inscription
4. Vérifiez votre email si nécessaire

Étape 2 : Accéder aux paramètres API

1. Connectez-vous à votre compte Rizful
2. Accédez à la section "Settings" ou "API" dans votre tableau de bord
3. Cherchez la section "API Keys" ou "Clés API"

Étape 3 : Générer une clé API

1. Dans la section API Keys, cliquez sur "Generate New API Key" ou "Créer une nouvelle clé"
2. Donnez un nom à votre clé (ex: "Nostr Paywall Production" ou "Nostr Paywall Development")
3. Copiez la clé API générée immédiatement - elle ne sera affichée qu'une seule fois

⚠️ Important : Stockez votre clé API en sécurité. Si vous la perdez, vous devrez en générer une nouvelle.

Étape 4 : Configurer l'adresse Lightning (optionnel mais recommandé)

1. Dans les paramètres de votre compte, accédez à "Lightning Address" ou "Adresse Lightning"
2. Configurez une adresse Lightning personnalisée (ex: votre_nom@rizful.com)
3. Cette adresse facilitera la réception des paiements

Étape 5 : Activer l'authentification à deux facteurs (2FA)

Pour la sécurité de votre compte :

1. Accédez aux paramètres de sécurité
2. Activez l'authentification à deux facteurs (2FA)
3. Utilisez une application d'authentification comme Google Authenticator ou Microsoft Authenticator

Note : La 2FA est obligatoire pour les comptes détenant plus de 100 000 satoshis.

Configuration dans le projet

Variables d'environnement

Une fois votre clé API obtenue, configurez-la dans votre environnement :

Développement local (.env.local)

Créez ou modifiez le fichier .env.local à la racine du projet :

# Rizful API Configuration (SERVER-SIDE ONLY)
RIZFUL_API_KEY=votre_clé_api_ici
RIZFUL_API_URL=https://api.rizful.com

# Variables publiques (client-side)
NEXT_PUBLIC_NOSTR_RELAY_URL=wss://relay.damus.io
NEXT_PUBLIC_NOSTRCONNECT_BRIDGE=  # Optional: nos2x extension is used by default

⚠️ Important :

• Ne mettez PAS NEXT_PUBLIC_ devant RIZFUL_API_KEY
• Cette clé doit rester côté serveur uniquement
• Ne commitez jamais le fichier .env.local dans Git (il est déjà dans .gitignore)

Production (Vercel, Netlify, etc.)

1. Accédez aux paramètres de votre projet sur votre plateforme d'hébergement
2. Allez dans la section "Environment Variables" ou "Variables d'environnement"
3. Ajoutez la variable :
   • Name : RIZFUL_API_KEY
   • Value : votre clé API Rizful
   • Environment : Production (et/ou Preview si nécessaire)
4. Ajoutez également RIZFUL_API_URL si vous utilisez une URL différente

Vérification de la configuration

Pour vérifier que votre clé API est correctement configurée :

1. Lancez le serveur de développement : npm run dev
2. Essayez de créer une facture Lightning via l'interface
3. Vérifiez la console du navigateur et les logs du serveur pour les erreurs

Si vous voyez une erreur "RIZFUL_API_KEY not configured", vérifiez :

• Que la variable est bien définie dans .env.local (développement)
• Que la variable est bien configurée dans votre plateforme d'hébergement (production)
• Que vous avez redémarré le serveur après avoir ajouté la variable

Sécurité

Bonnes pratiques

1. Ne partagez jamais votre clé API
2. Ne commitez jamais votre clé API dans le dépôt Git
3. Utilisez des clés différentes pour le développement et la production
4. Régénérez votre clé si elle est compromise
5. Activez la 2FA sur votre compte Rizful

Limitation d'accès (si disponible)

Dans les paramètres de votre compte Rizful, vous pourriez pouvoir :

• Limiter l'utilisation de la clé API par IP
• Limiter l'utilisation par domaine/origine
• Révoquer et régénérer des clés

Consultez la documentation Rizful pour ces fonctionnalités.

Documentation Rizful

Pour plus d'informations :

• Site web : https://rizful.com/
• Documentation API : Vérifiez la section "API" ou "Documentation" sur le site
• Support : Contactez le support Rizful si vous avez des questions

Dépannage

Erreur : "RIZFUL_API_KEY not configured"

Solution : Vérifiez que la variable d'environnement est bien définie et que le serveur a été redémarré.

Erreur : "Failed to create invoice"

Solutions possibles :

• Vérifiez que votre clé API est valide
• Vérifiez que votre compte Rizful est actif
• Vérifiez les logs serveur pour plus de détails
• Contactez le support Rizful si le problème persiste

Erreur : "Unauthorized" ou "401"

Solution : Votre clé API est invalide ou expirée. Régénérez une nouvelle clé dans votre compte Rizful.