Providers

Each source and certain destinations (such as Sync Destinations), will require some authentication, which differs per ProviderType.

You can learn which providers are available and their authentication support by Listing Providers.

To set the authentication for a source or destination, please review Provider Authentication.

Listing Providers

This method acquires the data providers that are presently available on FitnessSyncer. It should be noted that this method is highly cacheable, especially if you are using a fixed set of providers.

Request Parameters

None

Response

The Response will be a JSON body with Provider List.

Provider Authentication

There are various ways to configure authentication for a provider. The provider list would have provided you with a value for authenticating.

Once you have selected a provider and created a source for it, you need to add authentication for it as follows.

You should build your application such that if there are new values, your application degrades gracefully.

Where id is the id of the Source or Destination you are trying to authenticate.

Request Parameters

The request body will contain a JSON object as described here.

UsernamePassword

This will securely store the authentication on our servers and return a 200 response to you on success.

UsernamePasswordKey

This will securely store the authentication on our servers and return a 200 response to you on success.

Identifier

This will securely store the identifier for the service on our servers and return a 200 response to you on success. An identifier may only be registered to one FitnessSyncer account at a time; registering one already claimed by another account returns a 409.

OAuth

This will start the redirects required to authenticate an OAuth-like scheme. This will return a 202 to you with a Location header to pass onto your user. Your user will end at the URL provided below on success or failure (except where beyond our control or extreme failures).

See the sequence diagram in Creating new Data Sources to see how this works visually.

OAuthReuse

This re-uses the authentication for another source or destination referenced by the id field. See Provider Authenticate for how to get the id field for this request.

This will store the re-use request and will return a 200 response to you on success.

Response

If your request has been stored successfully, the response code will be a 200 without a body.

If your request has been initiated successfully, the response code will be a 202. Such a request will contain a Location header that you must send your user to. That location will be directed back to a FitnessSyncer service that will drive the completion of the request and redirect the user back to your site when the request is successful or has failed.

Existing Provider Authentication

For OAuth-based services, if you are using the same ProviderType for multiple sources and destinations for the same user, you need to use the same authentication for each source. This method will allow you to acquire the authorization summary of what exists already so that you can re-use that authentication.

Once you have the selected value, you can use the OAuthReuse authentication scheme.

curl -H "Authorization: Bearer AccessToken" "https://api.fitnesssyncer.com/api/providers/authentication/"

Request Parameters

None

Response

The Response will be a JSON body with a Providers Authentication.

Example JSON

{"providers": [{
    "keys": [{
        "name": "Fitbit Sleep Source",
        "id": "d8e1eb2e-bf26-4521-8c4b-7d85590e0588"
    }],
    "name": "Fitbit",
    "type": "FitBit"
}]}

Cloud Storage File Formats

The Cloud Storage providers (Amazon S3, DropBox, Google Drive, and OneDrive) store your data as individual files in your own cloud storage account, rather than in a third-party service’s own data model. Because there is no fixed schema being synchronized against, you choose the file format that gets written (or read) for each Source or Destination Task that uses one of these providers.

The file format, along with an optional storage path and filename template, is configured via a providerConfig.maps object on the Source Data or Sync Destination Task.

Not every file format supports every TaskType. TCX, GPX, KML, KMZ, PWX, and CSV are GPS track formats and only support Activity. FIT additionally supports Weight and Blood Pressure. FitnessSyncerAPI — FitnessSyncer’s own JSON representation of an Item, the same shape used elsewhere in this API — is the only format that supports every TaskType, and is the recommended choice for any TaskType other than Activity.

If you configure a fileFormat that does not support the TaskType of the Source or Destination Task, your request will be rejected with a 400 response describing the mismatch.

The Uploading Fitness Files endpoint also accepts a .fsapi file using this same JSON format, for any TaskType.

Types

List of Providers

Provider