User Registration API

1Overview

The HyGear Partner API lets an approved partner (for example, a CRM or membership system) create users in the HyGear platform and add them to one of the organizations the partner was approved for. Use it when a member signs up in your system, so the member can log in to HABEATS right away.

2Quick start

1. Get your API key and organization ID from your HyGear contact.
2. Send a POST request to the endpoint below with the key in the body.
3. Check that the response has "success": true and save the returned userId.
4. The new member receives a welcome email and can log in to the HABEATS app.

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
  }'

3Authentication

Every request must include your API key. Send it in the JSON body as key (recommended), or as a ?key= query parameter. HTTP headers are not used for the key.

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

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

4Register a user

Request body: application/json. All requests must use HTTPS. One request registers one user.

5Request fields

6Responses

Success — 200 OK

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

Error

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

Base your logic on the HTTP status and data.errorCode. The message is meant for people to read and its wording may change.

7How users are handled

8Errors

9Rate limits

Each API key may send up to 60 requests per minute. Above that limit you get 429 with a Retry-After header in seconds. For bulk imports, space the requests out (for example, one per second), or contact us to arrange a one-time migration.

10Code examples

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"])

11Security checklist

• Store the API key in a secret manager or an environment variable, never in source code.
• Call the API only from your backend over HTTPS.
• Do not write the key to your logs, and do not include it in support tickets or screenshots.
• Send only data the member has agreed to share with their organization.
• If the key may have leaked, ask HyGear to replace it. The old key stops working immediately.

12Support

For technical questions, a new key, approval for an additional organization or help investigating a request, contact support@hygearfit.com. Please include the time of the request, the errorCode and the member's email (never the API key).