Skip to main content

Terms and definitions

The following entities and terms are used in APIs and Databases (DB) along with RookMotion products and will be covered to differentiate entities, actors, terms, and definitions.

General​

  • RookDev: Abbreviation of Rookeries Development Co., which is the legal name of the company owner of RookMotion service and development resources.
  • RookLeague: This is a set of final products for training built by RookDev using RookMotion. You can use it as a reference for RookMotion capabilities. The principal user of RookMotion is RookDev in their Saas product RookLeague. Products are first deployed and tested in RookLeague and then released for final Clients.
  • RookLink: Previous name for the RookMotion resources described here.

Business Logic​

  • Client: You or your Company, the Entity that will integrate RookMotion's capabilities into their products. The Client signs an agreement and receives AUTH token and extra documentation not public.
  • User: The final user of the Client. The users consume RookMotion resources in the back of the Client's app.
    • For a fitness app: The person who performs the training.
    • For an insurance app: The person covered by the insurance.
    • For a game app: The person who plays the game.
  • Training: Or activities, refers to the measurements and estimations records stored and grouped related to a Training Entity, which at the same time is related to properties such as Start time, End time, Training type (like running, boxing), Summaries (like duration, calories tot, time on each effort zone), sensor_id or device used for the training, user_id.
  • Sensor: The device which final users "wear" to measure biomarkers.

Definitions​

  • Tenancy: For each Client, a new set of resources are created, and its data is independently stored. If a Client requires different performance or storage resources on DB these modifications can be requested by the Client and RookDev will execute the changes only for the Client's tenancy.

Tokens​

  • AUTH_TOKEN: Auth key provided by Rookmotion
  • LEVEL_TOKEN: Client key provided by Rookmotion

Hostnames​

  • BASE_URL: Backend URL provided by Rookmotion
  • REMOTE_URL: Real-time URL provided by Rookmotion (if you don't have it you can set any url)
  • GAMIFICATION_URL: Gamification backend URL provided by Rookmotion (if you don't have it can set any url)