Documentation API
Intégrez votre entreprise lifestyle et vos événements à la plateforme Swingular
Authentification
Accès API sécurisé avec OAuth 2.0 et clés API
Points de terminaison
API REST complète pour les événements, les profils et plus encore
Documentation
Guides détaillés, exemples et références SDK
Aperçu de l'API
Premiers pas
1. S'inscrire comme partenaire
Avant d'accéder à l'API, vous devez vous inscrire comme partenaire Swingular. C'est gratuit et ça vous donne accès à notre niveau API de base.
2. Générer des clés API
Une fois inscrit, vous pouvez générer des clés API depuis votre tableau de bord partenaire. Ces clés servent à authentifier vos requêtes API.
3. Effectuer des requêtes API
Utilisez vos clés API pour effectuer des requêtes vers nos points de terminaison. Toutes les requêtes doivent passer par HTTPS et inclure votre clé API dans l'en-tête.
Authentification
Authentification par clé API
Incluez votre clé API dans l'en-tête Authorization de vos requêtes :
Authorization: Bearer YOUR_API_KEY
OAuth 2.0
Pour les applications qui ont besoin d'accéder aux données utilisateur, utilisez OAuth 2.0 :
// Step 1: Redirect to authorization URL https://api.swingular.com/oauth/authorize? client_id=YOUR_CLIENT_ID& redirect_uri=YOUR_REDIRECT_URI& response_type=code& scope=events.read,events.write
Limites de débit
Plan de base
- • 1,000 requests per day
- • 60 requests per minute
- • Cached responses for high-volume endpoints
Plan premium
- • 10,000 requests per day
- • 300 requests per minute
- • Priority access during high traffic
- • Dedicated support for API integration
Points de terminaison API
/events
Créez, lisez, mettez à jour et supprimez des événements. Filtrez par date, lieu et type.
/eventsLister tous les événements avec pagination et filtrage
/eventsCréer un nouvel événement
/events/{id}Obtenir un événement spécifique par ID
/events/{id}Mettre à jour un événement existant
/business
Gérez votre profil d'entreprise, vos horaires, vos équipements et vos photos.
/businessObtenir votre profil d'entreprise
/businessMettre à jour votre profil d'entreprise
/business/photosTéléverser des photos d'entreprise
/business/reviewsObtenir les avis pour votre entreprise
/analytics
Accédez aux données analytiques pour votre entreprise et vos événements.
/analytics/eventsObtenir les analytiques pour vos événements
/analytics/businessObtenir les analytiques pour votre profil d'entreprise
/analytics/demographicsObtenir les données démographiques de vos visiteurs
/analytics/reportsGénérer des rapports personnalisés
Prêt(e) à intégrer ?
Commencez avec notre API aujourd'hui et connectez votre entreprise lifestyle à des millions de clients potentiels.
Frequently Asked Questions
Quels langages de programmation sont pris en charge ?
Notre API REST fonctionne avec n'importe quel langage de programmation capable d'effectuer des requêtes HTTP. On fournit des SDK pour JavaScript, Python, PHP et .NET, avec d'autres langages à venir.
Y a-t-il un environnement sandbox pour les tests ?
Oui, on fournit un environnement sandbox complet avec des données de test qui reflètent notre API de production. Tous les partenaires ont accès au sandbox pendant le processus d'intégration.
Quelles sont les limites de débit pour l'API ?
Les partenaires de base obtiennent 1 000 requêtes par jour et 60 par minute. Les partenaires premium obtiennent 10 000 requêtes par jour et 300 par minute. Les plans Entreprise offrent des limites personnalisées.
Proposez-vous des notifications webhook ?
Oui, on prend en charge les webhooks pour les notifications en temps réel sur des événements comme les nouveaux RSVP, les mises à jour d'événements et les changements de profil d'entreprise. Les points de terminaison webhook sont configurables dans votre tableau de bord partenaire.
Comment obtenir du soutien pendant l'intégration ?
Tous les partenaires ont accès à notre équipe de soutien aux développeurs. Les partenaires premium bénéficient d'un soutien prioritaire avec des spécialistes d'intégration dédiés et des délais de réponse plus rapides.