Documentation

Last modified: May 27 2020 11:48. UTC

Introduction


Welcome to Dataships! The following instructions will allow you to set up your company’s data access gateway.

The Data Access Gateway and the Control Panel work together to automate the facilitation of your data subjects’ Rights under GDPR and CCPA.

The Control Panel is used by the company to bring all your sources of data together in one place. This is accessible only to those within your company.

Your data subjects can then access their individual personal data through the Data Access Gateway which sits on the company’s website. They are only able to see their individual data that the company holds on them.

Getting Started


The Data Access Gateway is available in various forms and you have the ability to customize it.

If your website DOES NOT have a signup/login area for your customers/users, follow the steps below:

  1. Insert your website URL on the Company Profile tab of the Data Access Gateway page and click Save.
  2. Customize the Data Access Gateway and generate your code automatically in the Customise tab of Data Access Gateway page.
  3. Copy the code generated and insert it into your web-page.

We would be happy to help you get setup as quickly as possible. Please contact us if you require any assistance.

CONTROL PANEL

Product Detail


The Control Panel allows you to:

  • Define the data you wish to collect from your customers or users in the Data Access Gateway.
  • Upload existing Customer Data to the database.
  • Integrate your existing data sources.
  • Manage, organize, change and export your customer's data.

Changelog


We will keep this section updated with the latest features that are included in the Control Panel. The changelog is a list of the new additions and backwards-incompatible updates.

July 27 2019

  • The new Control Panel has been updated with the modern design and has been made mobile responsive.

DATA ACCESS GATEWAY

Product Detail


The data access gateway allows your data subjects to exercise their rights under GDPR/CCPA. They can:

  • Sign up to your website.
  • Login to view the data you currently hold on them.
  • View and change the data they wish to share with you.
  • Provide consent to data collection and management defined by you or withhold consent from them.
  • View any historical data you have maintained with their account.
  • View and Download any documents you have uploaded to their account.
  • Download their data.
  • Request to be deleted from your database subject to your confirmation within a 30 day period.

Single Sign On (SSO)


The Data Access Gateway supports Single Sign On (SSO) with your website or platform using JWT Tokens.

If your website supports user signup/login then you can login or logout the customers/users in the Data Access Gateway in two simple steps:

  1. Generate a JWT token from backend. Read the steps to generate a JWT Token below.
  2. Redirect users to the URL with JWT token as a query parameter
    e.g. https://app.dataships.io/dag/widget/YOUR_PUBLIC_KEY/login?token=YOUR_ENCODED_TOKEN
  3. If the token is valid, your customer/user will be automatically logged into the Data Access Gateway.
  4. When it is necessary to log out your customer/user, redirect the iframe to load the logout URL
    e.g. https://app.dataships.io/dag/widget/YOUR_PUBLIC_KEY/logout.

Note: Dataships will expire any sessions after 60 minutes of inactivity.


Steps to generate the JWT Token:
  1. Use the JWT library to generate a token.
  2. Use HS512 as the Algorithm.
  3. Payload data must contain an "email" key and a valid email address as it's value.
  4. Copy your secret key from the Control Panel ( Path: Account Settings > Password & Key > API Keys ) .
  5. Use your secret key from the previous step as your-512-bit-secret to Verify Signature.
  6. Use the token as a query parameter in the webapp URL
    e.g. https://app.dataships.io/dag/widget/YOUR_PUBLIC_KEY/login?token=YOUR_ENCODED_TOKEN
Need Assistance?

We would be happy to help you get setup as quickly as possible.

Contact Support

Note: We recommend using the Webapp type of the Data Access Gateway for fast and easy setup.
See Getting Started Guide for all available options.

Changelog


We will keep this section updated with the latest features that are included in the data access gateway. The changelog is a list of the new additions and backwards-incompatible updates.

July 29 2019

  • The new Data Access Gateway (version 2) has been released which support integrations with third-party applications.
  • The Data Access Gateway can be embedded on any website as before.
  • The Data Access Gateway can also exist as a standalone product and you do not need to own a website use it. Contact sales for more support.

July 30 2019

  • The Data Access Gateway (version 1) has been released which allow customers to view, modify and update their personal data.
  • The Data Access Gateway can be embedded on any website.

Versioning


We are working continously to improve our product and services. The version of the product willbe updated if major technical changes are required. In this instance, Dataships’ account holders may need to update the script tag for viewing the latest changes. However, new versions are not introduced frequently and most of the time, new features will be automatically reflected in our products.

Version 1:

This is the latest version of the Data Access Gateway which is based on the Restful APIs and can be used for multiple products that Dataships offer. The documentation for this version is regularly being updated.

Unlimited Support

We provide unlimited support for ad-hoc questions and requests.

Contact Support