Skip to content
Last updated

Choosing the Right EGYM Equipment Vendor API

EGYM offers two integration models for connecting your equipment or services to the EGYM ecosystem.
This guide helps you understand the differences and choose the right approach.

📟 Equipment Vendor API (for standalone clients)

Best for:

  • Fitness equipment or measurement devices without their own backend infrastructure, or
  • Devices that directly connect to EGYM Cloud from the gym floor.

Key Characteristics:

  • Direct device-to-EGYM communication via HTTPS.
  • Authentication: BasicAuth (client_id + client_secret).
  • Credentials issued per gym location.
  • User (Gym Goer) Authentication handled on the device (e.g., via EGYM ID, RFID, or NFC).
  • Ideal for cardio, strength and measurement devices that generate results in gym.
  • Supports direct real-time data exchange.

Typical Flow:

[Device] → Authenticate (OAuth)
         → Get User Details
         → Get Training Plan / Submit Workout or Measurements

🌐 Equipment Vendor API (for server-to-server cases)

Best for:

  • Equipment vendors who already have their own cloud/backend collecting measurement data.
  • Use cases where devices do not directly communicate (in all cases directly) with EGYM Cloud.

Key Characteristics:

  • Your backend handles all or most communication with EGYM Cloud.
  • Authentication: API-Key.
  • Credentials issued per gym location.
  • Devices talk to your backend, which then syncs with EGYM (e.g. to calculate the overall results)
  • Suitable for batch data sync or large-scale centralized integrations.

Typical Flow:

[Device] → [Vendor Backend] → Authenticate (API-Key)
                             → Push/Fetch Data to/from EGYM

🔍 Quick Comparison

Feature / AspectStandalone Devices APIServer-to-Server API
ConnectionDevice → EGYM directlyVendor Backend → EGYM
AuthenticationBasicAuth (client_id + client_secret)API-Key
Credentials ScopePer gym locationPer gym location or gym chain
Auth LocationOn deviceOn device and/or vendor backend
Login MethodsEGYM ID credentials, RFID, NFCRFID, NFC, User Id
Real-time Interaction✅ Yes⚠️ Optional (often batched)
Best ForGym-floor connected machinesVendors with central cloud and cloud operations

🛠 When You’re Ready to Integrate

Once you’ve identified which integration model suits your setup, jump into the dedicated documentation for technical details:

  • Equipment Vendor API – Standalone Devices
    Includes:

    • Supported authentication flows (EGYM ID, RFID, NFC)
    • Terms & Conditions handling
    • Full API endpoint list and request/response examples
    • Error handling best practices

  • Equipment Vendor API – Server-to-Server
    Includes:

    • API-Key authentication
    • User identification methods (RFID, NFC, special cases)
    • Measurement submission formats
    • Error handling best practices

📩 Need Help?

For guidance on which model is right for you or to obtain credentials, contact integrations@egym.com.

 
Next page