Introduction to the Personal Data eXchange API
Almost every interaction with the Mydex platform involves accessing or updating data in a Personal Data Store (hereafter referred to as a PDS). As a developer, you can accomplish this by sending data along a secure connection between a Mydex member's PDS and your application via an API request.
The following section outlines the necessary steps for a developer, new to the Mydex platform services, to get going:
The first thing you need to do is create an account via our Connection Manager so you can access our developer Sandbox environment.
- Register and create your account. This includes setting up your very own MydexID and Personal Data Store on our live service which is free for life.
- Login to the Connection Manager.
- Request your own Dedicated Connection to The Sandbox. This will cover the datasets you initially want to experiment with that are relevant to your objectives. You will set out your specific use cases and make a GDPR declaration.
Mydex CIC will advise you once your Dedicated Connection is set up, and will supply you Dedicated Connection credentials as well as a set of OAuth2.0 credentials
- Once you have these, you will be able to use the Dedicated Connection NID and Dedicated Connection Token, along with an OAuth2.0 access token, to:
- register MydexIDs and Personal Data Stores
- make first time connections between a Personal Data Store and your own service
-
Use the Mydex
Developer Helper
to help you understand:
- what data is available within our Personal Data Store Master Schema;
- what data types, what fields and what, if any, validation rules that apply;
- what, at a specific personal data store level, is available within that PDS.
- Test sending data from your service to the personal data store.
- Test collecting data from a personal data store using one or more of the datasets contained within the your dedicated connection.
- Perform processing on collected data to meet your needs.