Vue d'ensemble de l'API

Le module Perfex CRM SaaS inclut une API REST qui vous permet de gérer votre plateforme SaaS de manière programmatique. Utile pour :

• Pages d'inscription personnalisées - Créez votre propre flux d'inscription
• Intégrations tierces - Connectez avec des outils externes (Zapier, Integromat, applications personnalisées)
• Automatisation de la facturation - Synchronisez avec des systèmes de facturation externes
• Surveillance - Créez des tableaux de bord et outils de monitoring personnalisés
• Applications mobiles - Créez des interfaces de gestion mobiles

Démarrer avec l'API

Étape 1 : Activer l'API

1. Allez dans SaaS Management → SuperAdmin Settings
2. Cliquez sur l'onglet API Settings
3. Activez l'API en la mettant sur ON
4. Générez un jeton API

Étape 2 : Authentification

Toutes les requêtes API nécessitent une authentification via un jeton Bearer dans l'en-tête de la requête :

Authorization: Bearer YOUR_API_TOKEN_HERE

Étape 3 : URL de base

L'URL de base de votre API est :

https://yoursite.com/api/saas/

Remplacez yoursite.com par votre domaine réel.

---

Exemple rapide

Voici un exemple rapide de création d'un locataire via l'API :

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Réponse :

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

Capacités de l'API

Groupe de points de terminaison	Ce que vous pouvez faire
Locataires	Créer, lire, mettre à jour, supprimer des locataires
Plans	Lister, créer, mettre à jour des plans
Abonnements	Gérer les abonnements des locataires
Utilisation	Interroger l'utilisation et les quotas des locataires

Pour la liste complète des points de terminaison, consultez la Référence API.

---

Limitation du débit

L'API applique une limitation du débit pour protéger votre serveur :

• 100 requêtes par minute par jeton API
• Les en-têtes de limitation sont inclus dans chaque réponse

Si vous dépassez la limite, vous recevrez une réponse 429 Too Many Requests.

---

Bonnes pratiques

1. Gardez votre jeton API secret - Ne l'exposez jamais dans du code client ou des dépôts publics
2. Utilisez HTTPS - Effectuez toujours les requêtes API via HTTPS
3. Gérez les erreurs correctement - Vérifiez les codes de statut des réponses et gérez les erreurs de manière appropriée
4. Mettez en cache lorsque possible - N'interrogez pas les mêmes données de manière répétée ; mettez en cache les réponses qui ne changent pas souvent

info

Besoin d'une intégration personnalisée ? Si l'API ne couvre pas votre cas d'usage, contactez-nous via le support. Nous développons constamment l'API en fonction des retours clients.

Référence API