API לרישום משתמשים

1סקירה

HyGear Partner API מאפשר לשותף מורשה (למשל, מערכת CRM או מערכת לניהול חברים) ליצור משתמשים בפלטפורמת HyGear ולצרף אותם לאחד הארגונים שהשותף מורשה לפעול בהם. השתמשו בו כשחבר נרשם במערכת שלכם, כדי שיוכל להיכנס מיד ל-HABEATS.

2התחלה מהירה

1. קבלו את מפתח ה-API ואת מזהה הארגון מאיש הקשר שלכם ב-HyGear.
2. שלחו בקשת POST לנקודת הקצה שבהמשך, עם המפתח בגוף הבקשה.
3. ודאו שהתשובה כוללת "success": true ושמרו את ה-userId שהוחזר.
4. החבר החדש מקבל מייל ברוכים הבאים עם פרטי הכניסה ויכול להיכנס לאפליקציית HABEATS.

curl -X POST 'https://api.hygearfit.com/api/v1/integrations/users' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "hg_YOUR_API_KEY",
    "accountId": "YOUR_ORGANIZATION_ID",
    "fullName": "Dana Cohen",
    "email": "dana@example.com",
    "phone": "+972541234567",
    "gender": "female",
    "birthday": "1990-05-17",
    "height": 168,
    "weight": 62
  }'

3אימות

כל בקשה חייבת לכלול את מפתח ה-API שלכם. שלחו אותו בגוף ה-JSON בשדה key (מומלץ), או כפרמטר שאילתה ?key=. כותרות HTTP אינן משמשות להעברת המפתח.

{ "key": "hg_YOUR_API_KEY", "accountId": "...", "fullName": "...", "email": "..." }

POST https://api.hygearfit.com/api/v1/integrations/users?key=hg_YOUR_API_KEY

4רישום משתמש

גוף הבקשה: application/json. כל הבקשות חייבות להישלח ב-HTTPS. כל בקשה רושמת משתמש אחד.

5שדות הבקשה

6תשובות

הצלחה — 200 OK

{
  "success": true,
  "message": "",
  "data": {
    "userId": "6ac3a7613a9a66c800dd7b21",
    "accountId": "YOUR_ORGANIZATION_ID",
    "created": true   // false = the email already existed
  }
}

שגיאה

{
  "success": false,
  "message": "A valid email is required",
  "data": { "errorCode": "INTEGRATION_USER_EMAIL_INVALID" }
}

בססו את הלוגיקה שלכם על סטטוס ה-HTTP ועל data.errorCode. השדה message מיועד לקריאה אנושית, והנוסח שלו עשוי להשתנות.

7הטיפול במשתמשים

8שגיאות

9מגבלות קצב

כל מפתח API יכול לשלוח עד 60 בקשות בדקה. בחריגה מהמגבלה תתקבל תשובת 429 עם כותרת Retry-After שמציינת את זמן ההמתנה בשניות. בייבוא מרוכז, רווחו בין הבקשות (למשל, בקשה אחת בשנייה), או פנו אלינו לתיאום העברת נתונים חד-פעמית.

10דוגמאות קוד

Node.js (18+)

const response = await fetch('https://api.hygearfit.com/api/v1/integrations/users', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    key: process.env.HYGEAR_API_KEY,
    accountId: process.env.HYGEAR_ACCOUNT_ID,
    fullName: 'Dana Cohen',
    email: 'dana@example.com',
    phone: '+972541234567',
    gender: 'female',
    age: 35,
  }),
})
const result = await response.json()
if (!result.success) {
  throw new Error(`HyGear ${response.status}: ${result.data?.errorCode}`)
}
console.log(result.data.userId, result.data.created)

Python

import os, requests

response = requests.post(
    "https://api.hygearfit.com/api/v1/integrations/users",
    json={
        "key": os.environ["HYGEAR_API_KEY"],
        "accountId": os.environ["HYGEAR_ACCOUNT_ID"],
        "fullName": "Dana Cohen",
        "email": "dana@example.com",
        "birthday": "1990-05-17",
    },
    timeout=15,
)
result = response.json()
if not result.get("success"):
    raise RuntimeError(f"HyGear {response.status_code}: {result['data'].get('errorCode')}")
print(result["data"]["userId"], result["data"]["created"])

11רשימת בדיקה לאבטחה

• שמרו את מפתח ה-API במערכת לניהול סודות או במשתנה סביבה, לעולם לא בקוד המקור.
• פנו ל-API רק מצד השרת שלכם, ב-HTTPS.
• אל תכתבו את המפתח ביומני המערכת, ואל תכללו אותו בפניות לתמיכה או בצילומי מסך.
• שלחו רק נתונים שהחבר הסכים לשתף עם הארגון שלו.
• אם יש חשש שהמפתח דלף, בקשו מ-HyGear להחליף אותו. המפתח הישן מפסיק לעבוד מיד.

12תמיכה

לשאלות טכניות, לקבלת מפתח חדש, להרשאה לפעול בארגון נוסף או לעזרה בבירור בקשה, פנו אל support@hygearfit.com. ציינו את מועד הבקשה, את ה-errorCode ואת כתובת האימייל של החבר (לעולם לא את מפתח ה-API).