Configuration - API & Développeurs

💡 C'est quoi une API ? (En simple)

Une API (Application Programming Interface) est comme un "pont numérique" sécurisé qui permet à d'autres logiciels ou à votre propre site web de discuter automatiquement avec Pep's Up pour échanger des informations sans intervention humaine.

🔧 Détail des paramètres par catégorie

Pour chaque type de données, vous pouvez utiliser des filtres spécifiques dans vos requêtes pour affiner les résultats.

1. Événements (/evenements)

Permet de récupérer le calendrier de l'association.

• page (Entier) : Numéro de la page de résultats (défaut : 0).
• search (Texte) : Recherche textuelle dans le nom ou la description.
• published (Vrai/Faux) : Filtrer uniquement les événements publiés ou non.
• paying (Vrai/Faux) : Filtrer selon si l'événement est payant ou gratuit.
• dateStart (Date) : Filtrer les événements commençant à partir de cette date (format dd/MM/yyyy).
• dateEnd (Date) : Filtrer les événements se terminant avant cette date (format dd/MM/yyyy).

2. Dossiers d'adhésions (/dossiers-adhesions)

Permet de suivre les inscriptions.

• page (Entier) : Numéro de la page (défaut : 0).
• search (Texte) : Recherche textuelle sur le nom de l'adhérent.
• status (Liste) : Filtrer par état du dossier (ex: CREATING, TO_PROCESS, PAYING, PROCESSED, REFUSED...).

3. Contacts (/contacts)

Permet d'accéder à la base des membres.

• city (Texte) : Filtrer les membres par ville.
• sortBy (Texte) : Choisir le champ utilisé pour le tri (ex: Town, Lastname).
• sortDir (Texte) : Direction du tri (ASC pour croissant, DESC pour décroissant).

⚠ Gestion des accès (Clés API)

L'API est sécurisée et nécessite une authentification. La gestion des clés est centralisée.

Procédure obligatoire :

1. Activation : Pour obtenir votre clé API, vous devez contacter directement le Support Technique de Pep's Up.
2. Révocation : Si vous souhaitez couper un accès tiers, demandez la révocation immédiate de la clé au support.

✅ Bonnes pratiques

• Ne communiquez jamais votre clé API ; elle donne un accès direct aux données sensibles de l'association.
• Invitez votre développeur à tester les requêtes via le bouton "Authorize" sur l'interface Swagger avant intégration.