Creation of a new application - Medisana/vitadock-api GitHub Wiki

Account

Test server

  • Register new account on the test server.
  • Contact us to give your account the developer access.

Production server

  • Register new account (or login to existing account) on the production server.
  • [Contact us](mailto:[email protected]?subject=Developer access) using your email address you have used for registration.
    • Please provide us with a short description and/or URL of your project.
    • We are offering a chat with our software architect to discuss the implementation, feel free to ask if you are interested (usually this speeds up initial implementation).

Administration

  • Once cleared your account will have new options in the settings / applications (production server) view
  • Here you can create a new application or manage your existing applications:
    • The Application Name is mandatory.
    • Company, Version Number, Description, Website URL, Callback URL and Monitoring URL will be displayed to the VitaDock Online User when you ask him for permission to access his data.
    • Callback URL and Monitoring URL will be the two main interfaces to communicate with VitaDock Online.
    • If no Callback URL is provided then the user is displayed the Verifier Token in the browser and he has to communicate it to your application by other means (telephone, SMS, manual entry etc.).
    • If no Monitoring URL is provided then your application will not be notified when new data has arrived for a connected VitaDock Online User. Please note that you also need to setup proper Access Rights to allow monitoring.
    • Check Mobile if you are developing a distributed application (for PC, MAC, iPhone etc.).
    • Read and agree to the terms of use.

Confirm and ** write down Application Token and Application Secret.** Currently it is only displayed once.

Access rights

Finally you can setup new Access Rights and assign them to your application. Please note that you have to create one Access Right for each module you want to access. The defaults for Valid, Amount, History, Read, Write and Monitor are set for maximal access. Feel free to use lower values if needed, this increases the trust of the VitaDock Online User in your system.

  • Valid: Number of accesses until this token becomes invalid, e.g. 1 for tokens that can be used only once (use -1 if you want unlimited accesses).
  • Amount: Number of data entries to retrieve with each access (currently limited to 100).
  • History: Number of days to access, e.g. 30 for having access to the last 30 days (use -1 if you want to access all data).
  • Read: Check if your application should be able to read data from the user account.
  • Write: Check if your application should be able to execute write operations on the user account.
  • Monitor: Check if your application should be notified using your subscription URL if there is new data on the user account.

_When all is set up you are ready to use the Application Token and Application Secret in your application to request permission to access a VitaDock Online User's data.