Documentation


Last modified: June 24 2019 16:39. UTC

Introduction


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

The widget and control panel work together to bring you a complete solution for managing data access requests under GDPR and the management of data subjects' personal data.

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.

The company’s data subjects can then access their individual personal data through the widget which sits on the company’s website. They are only able to see data that the company holds on them specifically.

Getting Started


There are two types of Dataships widget; one for sites with login functionality and one for those without.

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 Profile Data tab of the Data Access Gateway page and click Save.
  2. Customize the widget and generate your code automatically.
  3. Copy the code generated and insert it into your web-page.

Add Widget


Below are steps that can be taken to customize the position and look of the widget on your site.

px
px

Copy this code, and then paste it into the homepage of your website's HTML code before the closing </body> tag

Script Tag

                      
                      <script  id="dag" type="text/javascript" src="https://api.dataships.io/js/dag.js?api_key=YOUR_API_KEY"></script>

Completing these steps should allow you to customize the widget. However, if you are still having trouble please Contact us for help.

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 database.
  • Integrate your existing data sources.
  • Manage, organize, change and export your customer 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.

May 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. 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.
  • Download their data.
  • Request to be deleted from your database subject to your confirmation within a 30 day period.

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.

May 27 2019

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

Apr 1 2018

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

Versioning


We are working continously to improve our product and services. We update the version of the widget if there are major technical changes and users might have to update the script tag for viewing the latest changes. However, new versions are not introduced frequently and most of the times, new features will reflect automatically.

Version 2:

This is the latest version of the widget which is based on the Restful APIs and can be used for multiple products that Dataships offer. The documentation for this version is a work in progress.

Version 1: Deprecated

Click here to see documentation for version 1.

Note: This version has been deprecated, kindly migrate to the newer version of the data access gateway (v2).

SUPPORT

Platforms Support


Our widget is a simple javascript plugin which can be embedded on any website. You can either copy the script code from above and add it to your HTML file or embedd it in any platform. Click below to view the platforms that we support. If you still have any problems getting the widget on your website then please Contact us for assistance.

See Platforms

We are always looking to improve our offering by supporting more platforms.

Integrations


Note: This feature is only available with version 2 of the widget.

Currently our tool integrates with a number of other applications. These integrations allow our users to connect their multiple data sources together and display them as one to their data subjects.

FAQ


  • Question 1: I tried to load the widget on my website but the widgetis not showing anything ?
    Answer: Make sure you have added the right website URL in the Control Panel where you are trying to load the widget.
  • Question 2: I already have other widget on the website ?
    Answer: We give you the power to adjust the location of the widget on the website, so you can decide the position for the widget before copying the script tag here.
  • Question 3: Widget was added successfully but some design was broken ?
    Answer: We have tried our best to keep the widget highly independent of the styles of the webpages and it should not really happen. In case it is observed, please report the error immediately to help us fix it.
  • Question 4: I do not have a website, is there a way to still use data acess gateway ?
    Answer: In the present world everybody needs an online presence and we provide you the resources to take your website and data access gateway online. Please contact sales, we provide all the necessary support in this regard.
  • Question 5: What should I do if my data sources do not reflect in the widget ?
    Answer: Please contact support team.
  • Question 6: An integration was added to my account but I cannot see the data source in the widget?
    Answer: Sometimes cache might cause problems. Use Ctrl+F5(windows/ubuntu) or Cmd+R(mac) to hard refresh the page, if that does not fix the problem, you will need to contact support team.