Custom Marketplace

Our Enterprise customers may also design and create a custom implementation of their own Validic App Marketplace.

Customizing Your Own App Marketplace

Apps.JSON

{
  "summary": {
    "status": 200,
    "message": "Ok",
    "results": 1,
    "start_date": "2015-12-06T00:00:00+00:00",
    "end_date": "2015-12-08T23:59:59+00:00",
    "offset": 0,
    "limit": null,
    "previous": null,
    "next": null,
    "params": {
      "start_date": null,
      "end_date": null,
      "offset": 0,
      "limit": 0
    }
  },
  "apps": [
    {
      "name": "Jawbone UP",
      "sync_url": "https://app.validic.com/organizations/53edef21edd242SAMPLE0048/auth/jawbone_up?user_token=DhQMRhSosMXn7tL_SvnS&format_redirect=json",
      "unsync_url": "https://app.validic.com/organizations/53edef21edd24SAMPLE00048/unsync/jawbone_up?user_token=DhQMRhSosMXn7tL_SvnS&format_redirect=json",
      "refresh_url": "https://app.validic.com/organizations/53edef21edd242SAMPLE00048/refresh/jawbone_up?user_token=DhQMRhSosMXn7tL_SvnS&format_redirect=json",
      "download_link": "https://jawbone.com/up/devices",
      "excerpt": "UP is a wristband and app that tracks how you sleep, move and eat.",
      "extra_excerpt": "UP was designed to fit seamlessly in people's lives. Real life. It's a thoughtful combination of engineering and design, custom-made for how we live. UP is both flexible and strong. Sometimes UP needs to slide smoothly under sleeves or bend to accommodate an active lifestyle. Other times it has to be strong enough to stand up to a snowball fight without a problem (or more likely, a few thousand showers). Day and night, UP is right there with you.",
      "subname": "jawbone_up",
      "kind": [
        "Routine",
        "Fitness",
        "Nutrition",
        "Sleep",
        "Weight"
      ],
      "logo_url": "/assets/appicons/jawbone_up-icon.png",
      "platform_types": [
        "Android",
        "iOS",
        "Windows Phone"
      ],
      "synced": true,
      "last_sync": "2015-12-07T19:03:27+00:00"
    }
  ]
}

To deploy the marketplace, you will need your Organization’s ID, your Organization’s Access Token, and the User Access Token created when you provisioned the user.

The Validic App Marketplace is specific to each user, listing all apps and their appropriate sync, refresh, and unsync URLs.
To sync an application, simply use the sync URL for the app which will bring the user to the app’s authorization page.
To unsync the app, simply pass on the unsync url for the app.
*The refresh URL acts as a trigger to fetch on demand the user’s app data from the source.

🚧
Note
The unsync and refresh URLs are only available once the app has been synced.

Before you begin, we highly suggest you watch the following video.

Example

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/apps.json?authentication_token={USER_ACCESS_TOKEN}&access_token={ORGANIZATION_ACCESS_TOKEN}

Return Value	Type	Description

Return Value	Type	Description
name	String	The display name for the app
sync_url	String	URI for redirecting the user to the app’s authorization page to sync the app
unsync_url	String	URI for unsyncing the app
refresh_url	String	URI for refreshing the user’s app data
download_link	String	URI for downloading the app software
excerpt	String	Short description of the app
extra_excerpt	String	Long description of the app
subname	String	Source filter name for the app
kind	Array	Shows data objects supported by application
logo_url	String	Relative path of the image icon for the app. Prepend with https://app.validic.com
platform_types	Array	Platforms where app is available
synced	Boolean	Synced status of the app
last_synced	String	Timestamp when the app was last synced by user

Controlling Sync, Refresh and Unsync redirect behavior

For custom marketplace implementations, additional control over the behavior of sync, unsync, or refresh call may be added through a redirect_uri parameter

Example

GET https://app.validic.com/organizations/{ORGANIZATION_ID}/auth/{SOURCE}?user_token={USER_ACCESS_TOKEN}&format_redirect=json&redirect_uri={URI}

Redirect_URI Example

This will redirect the user the specified resource after a successful request.

Additional Display of Supported Devices

You may additionally display supported devices for each app by adding an expanded filter and setting it to 1.

Text

Apps.JSON Expanded

Return Value	Type	Description

Return Value	Type	Description
name	String	The display name for the device
type	String	Type of device
description	String	Long description for the device
excerpt	String	Short description for the device
resource_url	String	URI for vendor device information
data_objects	Array	API Data Objects supported by device
kind	Array	Shows Data Object supported by this device
image_url	String	URI for the image icon for the device
discontinued	Boolean	Market availability status of the device