This guide explains the different integration patterns available when connecting your member management system (MMS) with EGYM. Understanding these patterns will help you choose the right approach for your use case and implement a robust, bidirectional synchronization strategy.
EGYM MMS API v2 supports two primary data flow patterns:
- PUSH integration - Your system sends data to EGYM
- PULL integration - Your system retrieves data from EGYM
Most integrations use a combination of both patterns to maintain bidirectional synchronization and ensure data consistency across systems.
PUSH integration means your MMS actively sends member data to EGYM whenever changes occur in your system.
Use PUSH integration when:
- Members are created or updated in your MMS
- Membership contracts are modified (upgrades, extensions, cancellations)
- Member personal information changes (email, name, contact details)
- You need to ensure EGYM has the latest member data immediately
| Operation | Method | Endpoint | Purpose |
|---|---|---|---|
| Create member | POST | /api/v2/accounts | Add new membership data to EGYM |
| Update member | PUT | /api/v2/accounts/{accountId} | Modify existing membership data |
| Delete member | DELETE | /api/v2/accounts/{accountId} | Remove membership data |
| Upload profile picture | POST | /api/v2/accounts/{accountId}/image | Add member photo |
Member signs up in your MMS
↓
Your system calls POST /api/v2/accounts
↓
Store returned accountId in your database
↓
Member upgrades membership in your MMS
↓
Your system calls PUT /api/v2/accounts/{accountId}
↓
EGYM receives updated membership informationImplementing conflict resolution is mandatory for PUSH integration. Your system must automatically detect and resolve HTTP 409 conflicts that occur due to uniqueness constraints (duplicate emails or membershipIds). See the Conflict Resolution guide for complete details.
For detailed guidance on implementing PUSH integration, see:
- Push member data to EGYM - Complete guide with examples
- Conflict Resolution - Required reading for handling conflicts
PULL integration means your system retrieves member data from EGYM on a regular schedule or on-demand.
Use PULL integration when you are a non-MMS partner who needs to retrieve membership data that was sent to EGYM by MMS partners. This allows you to:
- Access member information managed by gym management systems
- Synchronize membership data to your system
- Perform initial data import of members
- Keep your system updated with membership changes on a regular schedule
| Operation | Method | Endpoint | Purpose |
|---|---|---|---|
| List members | GET | /api/v2/accounts | Retrieve member accounts with filters |
| Get member details | GET | /api/v2/accounts/{accountId} | Fetch specific member information |
Schedule periodic sync (every 10 minutes)
↓
Call GET /api/v2/accounts with time filters
↓
Process returned member updates
↓
Update members in your MMS database
↓
Store sync timestamp for next iterationFor detailed guidance on implementing PULL integration, see:
- Pull member data from EGYM - Complete synchronization guide
- Push member data to EGYM - PUSH integration guide
- Pull member data from EGYM - PULL integration guide
- EGYM Member Account Concept - Understanding account structure
- Conflict Resolution - Handling data conflicts
- API Reference - Complete endpoint documentation
- Webhooks - Real-time event notifications