👨‍💻For Developers

In this guide, we provide detailed instructions for connecting a Data Holder to MyDataCoin Bridge and receiving requests.

ProfileDisclaimer: The development team is working diligently, and the documentation will be updated with each new release.

Table of contents:

System Requirements

  • Hardware: CPU: Intel Core i3 or AMD Ryzen 3.

    RAM: At least 4GB.

    HDD: 20GB free space. 64-bit kernel and CPU support for virtualization.

  • Software: Linux 18.04 LTS or Higher, Windows 10 or Higher Docker for Linux or Windows

Overview

This guide provides a comprehensive explanation of how to effectively interact with the MyDataCoin ecosystem. To integrate successfully, you will need to set up an endpoint that can receive POST requests, which will, in turn, return the response described in the sections below.

Install Docker

Please select the appropriate link for your operation system and follow the provided instructions to install Docker:

If you use Ubuntu, and have a following error:

E: Package 'docker-ce' has no installation candidate
E: Unable to locate package docker-ce-cli
E: Unable to locate package containerd.io
E: Couldn't find any package by glob 'containerd.io'
E: Couldn't find any package by regex 'containerd.io'
E: Unable to locate package docker-buildx-plugin
E: Unable to locate package docker-compose-plugin

please visit: Link.

Installing Docker Compose

To make sure you obtain the most updated stable version of Docker Compose, you’ll download this software from its official Github repository.

First, confirm the latest version available in their releases page. At the time of this writing, the most current stable version is 1.29.2.

The following command will download the 1.29.2 release and save the executable file at /usr/local/bin/docker-compose, which will make this software globally accessible as docker-compose:

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

Next, set the correct permissions so that the docker-compose command is executable:

sudo chmod +x /usr/local/bin/docker-compose

To verify that the installation was successful, you can run:

docker-compose --version

Setup Docker

Before you begin, make sure that you have an Secret Token. You should have received this token after completing the registration process, as described here.

After Docker successfully installed, you need to download docker-compose.yml from our official repository:

git clone https://github.com/MyDataCoin/mdc-docker
  1. Open docker-compose.yml file to make changes;

  2. Get your Secret Token from https://app.mydatacoin.io/settings. You will find it in Settings tab;

  3. Put the token in AUTH_TOKEN env variable.

After you made changes, save the file and run the following command in terminal:

docker-compose up -d

Be sure, that port 8000 is open and ready for inbound connections. To change the settings, run the command: sudo ufw allow 8000/tcp

Upload a DataSet

Please ensure that you create a DataProvider entity in the Marketplace before uploading any datasets. To proceed, please provide your company information here.

Important! The data you upload will not be transferred to us or any third parties; it will be stored in your Docker container.

To prepare the data monetization process, you need to prepare a JSON file with data in the format User Model shown below.

After docker successfully started, you need to open browser and input the following url: http://your_server_address:8000/upload, then you'll see following page:

Put your Secret Token in the Secret Token field and give your dataset a name, choose a dataset you've prepared and press Upload.

Now you ready to go! Please feel free to ask any questions about integration process. Send us email to as@mydatacoin.io

User model sample

Json User Model
user.json
[
  {
     "profile":{
        "recordId": "1" or "dd3cc469-096f-4b9e-a8fb-ce5ef32c5642",
        "firstName":"John",
        "lastName":"Doe",
        "dateOfBirth":"1999-09-09T00:00:00Z",
        "gender":null,
        "email":"sagynbaev6@mail.com",
        "phone":"+7(777)222-33-44",
        "maritalStatus":0,
        "income":0
     },
     "basicData":{
        "interests":null,
        "languages":null,
        "religionViews":null,
        "politicalViews":null
     },
     "contacts":{
        "mobilePhone":null,
        "address":null,
        "linkedAccounts":null,
        "website":null
     },
     "workAndEducation":{
        "placeOfWork":null,
        "skills":null,
        "university":null,
        "faculty":null
     },
     "placeOfResidence":{
        "currentCity":null,
        "birthPlace":null,
        "otherCities":null
     },
     "personalInterests":{
        "briefDescription":null,
        "hobby":null,
        "sport":null
     },
     "deviceInformation":{
        "operatingSystem":null,
        "displayResolution":null,
        "browser":null,
        "iSP":null,
        "adBlock":false
     },
     "cookies":{
        "sessionState":null,
        "language":null,
        "region":null,
        "recentPages":null,
        "shoppingCart":[
           {
              "productId":null,
              "productName":"maxsimus1",
              "productPrice":null,
              "quantity":null,
              "subTotal":null,
              "total":null,
              "couponCode":null,
              "shippingInformation":null,
              "taxInformation":null
           },
           {
              "productId":null,
              "productName":"maxsimus",
              "productPrice":6565,
              "quantity":null,
              "subTotal":null,
              "total":null,
              "couponCode":null,
              "shippingInformation":null,
              "taxInformation":null
           }
        ]
     }
  },
  {
     "profile":{
        "firstName":"Jason",
        "lastName":"Cropp",
        "dateOfBirth":"2002-11-09T00:00:00Z",
        "gender":null,
        "email":[
           "amaymon02@mail.ru"
        ],
        "phone":[
           "+77443332424",
           "+996222334455"
        ],
        "maritalStatus":0,
        "income":0
     },
     "basicData":{
        "interests":null,
        "languages":null,
        "religionViews":null,
        "politicalViews":null
     },
     "contacts":{
        "mobilePhone":"IPHONE13",
        "address":null,
        "linkedAccounts":null,
        "website":null
     },
     "workAndEducation":{
        "placeOfWork":null,
        "skills":null,
        "university":"KNU",
        "faculty":null
     },
     "placeOfResidence":{
        "currentCity":null,
        "birthPlace":"bishkek",
        "otherCities":null
     },
     "personalInterests":{
        "briefDescription":null,
        "hobby":[
           "biohacking"
        ],
        "sport":[
           "boxing"
        ]
     },
     "deviceInformation":{
        "operatingSystem":null,
        "displayResolution":null,
        "browser":null,
        "iSP":null,
        "adBlock":true
     },
     "cookies":{
        "sessionState":null,
        "language":null,
        "region":"chui area",
        "recentPages":null,
     },
     "shoppingCart":[
        {
           "productId":1,
           "productName":"pen",
           "productPrice":12,
           "quantity":2,
           "subTotal":24,
           "total":null,
           "couponCode":null,
           "shippingInformation":null,
           "taxInformation":null
        },
        {
           "productId":2,
           "productName":"cup",
           "productPrice":30,
           "quantity":1,
           "subTotal":null,
           "total":null,
           "couponCode":null,
           "shippingInformation":null,
           "taxInformation":null
        }
     ]
  }
]

Model details:

Profile

BasicData

Contacts

WorkAndEducation

PlaceOfResidence

PersonalInterests

DeviceInformation

Cookies

ShoppingCart

MaritalStatus

Marital status is a characteristic that reflects a person's marital status. Depending on the country and culture, there are different categories of marital statuses. Some of them may include:

Add Records

These two methods serve to update and add users, add user api/v1/insert serves so that you do not have to form json every time and fill it with the /upload method, instead you can simply write a function that will be executed when you add a new user to the database, that is, you simply add to yours and simultaneously make a request to our database data, in the future this will free you from the constant updating of data.

Inserts new user profile

POST https://your-ip-address:your-port/api/v1/insert

All the body parameters described in User Model

Headers

Request Body

{
    "success": "profile add successfully"
}
curl -X PUT "http://your-server-ip:8000/api/v1/insert" \
     -H "Authorization: your_auth_token_here" \
     -H "Content-Type: application/json" \
     -d '{
    "profile": {
        "recordId": "54",
        "firstName": "Alex",
        "lastName": "Vishnevski",
        "dateOfBirth": "2002-11-09T00:00:00Z",
        "gender": 1,
        "email": ["amaymon02@mai8.ru"],
        "phone": ["+996222116992", "+996555848652"],
        "maritalStatus": 0,
        "income": 0
    },
    "basicData": {
        "interests": ["hobbyhorsing","boxing"],
        "languages": ["english", "indian"],
        "religionViews": ["Atheist","Agnostik"],
        "politicalViews": ["liberal"]
    },
    "contacts": {
        "mobilePhone": "IPHONE13",
        "address": "avenue 13",
        "linkedAccounts": ["https://www.tiktok.com/@angiejoliefan?is_from_webapp=1&sender_device=pc"],
        "website": "http://flibusta.site/b/668844/read"
    },
    "workAndEducation": {
        "placeOfWork": "MydataCoin",
        "skills": ["Attractive"],
        "university": "KNU",
        "faculty": "ФИиИт"
    },
    "placeOfResidence": {
        "currentCity": "New-York",
        "birthPlace": "bishkek",
        "otherCities": ["Astana","Peru","Amsterdam"]
    },
    "personalInterests": {
        "briefDescription": "Smart",
        "hobby": ["biohacking"],
        "sport": ["boxing"]
    },
    "deviceInformation": {
        "deviceName": "Mac m2 pro",
        "deviceId": "21313-asdasd-12313",
        "operatingSystem": "windows",
        "displayResolution": "999X999",
        "browser": "internet explorer",
        "iSP": "megaCom provider",
        "adBlock": true
    },
    "cookies": {
        "sessionState": "Active",
        "language": "Russia",
        "region": "chui area",
        "recentPages": ["https://ru.wikipedia.org/wiki%D0%A5%D0%BE%D0%B1%D0%B1%D0%B8%D1%85%D0%BE%D1%80%D1%81%D0%B8%D0%BD%D0%B3"],
        "shoppingCart": [
            {
                "productId": 123,
                "productName": "dragon",
                "productPrice": 100000000,
                "quantity": 1,
                "subTotal": 120000,
                "total": 20,
                "couponCode": "free-dragondotpy",
                "shippingInformation": "st.Avenue 13",
                "taxInformation": "12.23"
            },
            {
                "productId": 1233,
                "productName": "dragon-wife",
                "productPrice": 1,
                "quantity": 1,
                "subTotal": 1,
                "total": 2,
                "couponCode": "free-incubator",
                "shippingInformation": "st.Avenue 13",
                "taxInformation": "0.01"
            }
        ]
    }
}'

Update Records

The update method serves to synchronize your database with ours, so that the data is always up to date, you just need to write a function that, when updating your user's data, it simultaneously updates the user in our database to keep personal data up to date

updating an existing user

PUT https://your-ip-address:your-port/api/v1/update?recordId=55

This method is used to update the data of an existing user, please note that identification occurs by recordId which is located separately outside the data to update

Query Parameters

Headers

Request Body

# with id profile in brecets
{
    "message":"profile {} successfully updated!"
}
curl -X PUT "http://your-server-ip:8000/api/v1/update?recordId=55" \
     -H "Authorization: your_auth_token_here" \
     -H "Content-Type: application/json" \
     -d '{
    "profile": {
        "recordId": "54",
        "firstName": "Alex",
        "lastName": "Vishnevski",
        "dateOfBirth": "2002-11-09T00:00:00Z",
        "gender": 1,
        "email": ["amaymon02@mai8.ru"],
        "phone": ["+996222116992", "+996555848652"],
        "maritalStatus": 0,
        "income": 0
    },
    "basicData": {
        "interests": ["hobbyhorsing","boxing"],
        "languages": ["english", "indian"],
        "religionViews": ["Atheist","Agnostik"],
        "politicalViews": ["liberal"]
    },
    "contacts": {
        "mobilePhone": "IPHONE13",
        "address": "avenue 13",
        "linkedAccounts": ["https://www.tiktok.com/@angiejoliefan?is_from_webapp=1&sender_device=pc"],
        "website": "http://flibusta.site/b/668844/read"
    },
    "workAndEducation": {
        "placeOfWork": "MydataCoin",
        "skills": ["Attractive"],
        "university": "KNU",
        "faculty": "ФИиИт"
    },
    "placeOfResidence": {
        "currentCity": "New-York",
        "birthPlace": "bishkek",
        "otherCities": ["Astana","Peru","Amsterdam"]
    },
    "personalInterests": {
        "briefDescription": "Smart",
        "hobby": ["biohacking"],
        "sport": ["boxing"]
    },
    "deviceInformation": {
        "deviceName": "Mac m2 pro",
        "deviceId": "21313-asdasd-12313",
        "operatingSystem": "windows",
        "displayResolution": "999X999",
        "browser": "internet explorer",
        "iSP": "megaCom provider",
        "adBlock": true
    },
    "cookies": {
        "sessionState": "Active",
        "language": "Russia",
        "region": "chui area",
        "recentPages": ["https://ru.wikipedia.org/wiki%D0%A5%D0%BE%D0%B1%D0%B1%D0%B8%D1%85%D0%BE%D1%80%D1%81%D0%B8%D0%BD%D0%B3"],
        "shoppingCart": [
            {
                "productId": 123,
                "productName": "dragon",
                "productPrice": 100000000,
                "quantity": 1,
                "subTotal": 120000,
                "total": 20,
                "couponCode": "free-dragondotpy",
                "shippingInformation": "st.Avenue 13",
                "taxInformation": "12.23"
            },
            {
                "productId": 1233,
                "productName": "dragon-wife",
                "productPrice": 1,
                "quantity": 1,
                "subTotal": 1,
                "total": 2,
                "couponCode": "free-incubator",
                "shippingInformation": "st.Avenue 13",
                "taxInformation": "0.01"
            }
        ]
    }
}'