Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

https://github.com/RADAR-base/RADAR-Rest-Source-Auth

The REST Source Authorizer is an application that allows the platform to get authorization data from users in order to get access to their data from 3rd party applications (through their REST API).

In order to get authorization data, the authorizer will redirect the user to the selected 3rd party web portal/dashboard. Once the credentials have been successfully authenticated, the user will then be redirected back to the REST Source authorizer where further details can be added and finally stored.

Currently, the following 3rd party APIs are supported:

  1. Garmin Health API

    1. See Push Endpoint

    2. The Garmin Health API uses OAuth1 authorization.

  2. Fitbit API

    1. See REST Connector

    2. The Fitbit API uses OAuth2 authorization.

Step-by-step Guide

  1. Visit the authorizer web app by going to http://domain-name/rest-sources/authorizer. Please ask your administrator to provide you with the correct url of the application.

    Image Added
  2. Once you open the application, click on “LOGIN WITH MANAGEMENT PORTAL”.

  3. This will redirect you to a Management Portal login screen. Enter your Management Portal credentials to login.

    Image Added
  4. Once you have successfully logged in, Please click on the Approve button.

    Image Added
  5. You will then see the home screen of the application. You can either make a request to get authorization details (“Request to Authorize”) or Select a project to view a list of users (by project) that have been authenticated.

    Image Added
  6. After selecting a project, you will see a list of authenticated users. You also have the option to View/Edit Info, Reset, or Delete the user.

  7. In order to authorize a user, you will need to choose a the service/device type (supported by the platform). Currently only the Fitbit and Garmin APIs are supported. After choosing a device, select Request to Authorize.

    Image Added
  8. This will then redirect you to the web portal of the selected service. In this case, we have chosen Fitbit. Enter your Fitbit credentials.

    Image Added
  9. After successful authentication with Fitbit, you will be redirected back to the authorizer where you can enter the user’s details. After entering the user’s details, click Submit.

    Image Added
  10. The user has now been successfully authorized and added to the platform. The platform (specifically the REST connector or Push Endpoint components) will now pull/receive data for this user from the 3rd party service.