Fit2Trade API documentation.

Token refresh

Generate a new access token and refresh token. The access token returned on success is valid for 24 hours.

Headers

Request body

Supply a raw JSON object containing the required RefreshToken string.

{
  "RefreshToken": "[refresh-token]"
}

Successful response

{
  "Status": "OK",
  "Error": { "ErrorCode": 0, "Message": "" },
  "Data": {
    "Token": "[new-access-token]",
    "RefreshToken": "[new-refresh-token]"
  }
}

Create or update users

Create or modify users. The request body is a raw JSON array of objects; a single user must still be sent as a single-value array. The maximum request size is 100 users.

User properties

Sample request

[
  {
    "FirstName": "John",
    "LastName": "Smith",
    "Email": "john@fit2trade.com",
    "LearnerRole": "sales",
    "ExternalID": "HG76GHF"
  },
  {
    "FirstName": "Barbara",
    "LastName": "Jones",
    "Email": "barbara@fit2trade.com",
    "ExternalID": "LKHG5HK8",
    "Location": {
      "LocationID": null,
      "ExternalID": null
    },
    "LearnerRole": "admin",
    "AdminRole": {
      "IsAdmin": true,
      "ViewOnly": false,
      "Location": {
        "LocationID": null,
        "ExternalID": null
      }
    }
  }
]

Response

On success, Data contains a list of user IDs and email addresses. A UserID of 0 means that user was not successfully created or updated.

Deactivate users

Archive users. Send a JSON array containing up to 100 users. Email is required and ExternalID is optional. Users identified by email are archived; email addresses not found are ignored.

[
  { "Email": "john@fit2trade.com" },
  { "Email": "barbara@fit2trade.com", "ExternalID": "LKHG5HK8" }
]

Reactivate users

Unarchive users. Send a JSON array containing up to 100 users. Email is required and ExternalID is optional.

[
  { "Email": "john@fit2trade.com" },
  { "Email": "barbara@fit2trade.com", "ExternalID": "LKHG5HK8" }
]

Course completions

Get the list of courses completed by users. Send a JSON array containing up to 100 users; Email is required for each object.

[
  { "Email": "john@fit2trade.com" },
  { "Email": "barbara@fit2trade.com" }
]

Sample response

{
  "Error": { "ErrorCode": 0, "Message": "" },
  "Status": "OK",
  "Data": [
    {
      "UserID": 1,
      "Email": "john@fit2trade.com",
      "Completions": [
        {
          "CourseID": 130,
          "Course": "Word Skills",
          "CompletionDate": "2023-12-31T00:00:00",
          "CertExpiryDate": "2026-08-06T00:00:00"
        }
      ]
    }
  ]
}

User credentials

Get a login token for a user. This token is valid for 5 minutes. The documented flow can be used to publish a link that signs a user into Fit2Trade automatically, provided the user's password in both applications is the same.

1. Call /api2/users/credentials to obtain the 5-minute login token.
2. Use that token with /api2/users/login to obtain a new login token valid for 8 hours.
3. Use [base_url]/api2/users/connect/[login_token] to access Fit2Trade without prompting the user to log in.

Request body

{
  "Email": "john@fit2trade.com"
}

Sample response

{
  "Error": { "ErrorCode": 0, "Message": "" },
  "Status": "OK",
  "Data": {
    "Email": "john@fit2trade.com",
    "LoginToken": "[5-minute-login-token]"
  }
}

Login user

Exchange the short-lived login token for a login token that is valid for 8 hours and can be used to create an access link to Fit2Trade without prompting the user to log in. The response also includes an Image property containing the Fit2Trade logo in SVG format.

Request body

{
  "Email": "john@fit2trade.com",
  "LoginToken": "[5-minute-login-token]",
  "Password": "[user-password]"
}

Sample response

{
  "Error": { "ErrorCode": 0, "Message": "" },
  "Status": "OK",
  "Data": {
    "Email": "john@fit2trade.com",
    "LoginToken": "[8-hour-login-token]",
    "Image": "<svg width="100%" height="100%"> … </svg>"
  }
}

Access Fit2Trade

Use the 8-hour login token to access Fit2Trade without prompting the user to log in.

Headers

If successful, the user is taken to their landing page. If not, the user is presented with the login page.