Installation and usage of the platform

REST API: confidential data exchange and obtaining of information about confidential data groups

https://img.shields.io/badge/auth-required-orange.svg

Learn more about confidential data exchange and access groups in the article Confidential data exchange.

A set of methods from the Privacy group is provided to implement these functions using the REST API:

POST /privacy/sendData

The method is designed to send sensitive data to the blockchain, available only to members of the access group defined for this data. The method request contains the following information:

  • sender - blockchain address from which the data should be sent (corresponds to the value of the “privacy.owner-address” parameter in the configuration file of the node);

  • password - password to access the private key in the node keystore;

  • policyId - identifier of a group that will have access to the data to be forwarded;

  • info - information about data being sent;

  • data - string containing data in base64 format;

  • hash - sha256-hash data in base58 format.

Examples of a query and a response:

POST /privacy/sendDataV2

The POST /privacy/sendDataV2 method is similar to the POST /privacy/sendData method, but allows you to attach a file in the Swagger window without having to convert it to base64 format. The Data field is missing in this version of the method.

Examples of a query and a response:

GET /privacy/{policy-id}/recipients

The method is designed to get the addresses of all members recorded in group {policy-id}.

The response of the method returns an array of strings with the addresses of the members of the access group.

Response example:

GET /privacy/{policy-id}/owners

The method is designed to get the addresses of the owners of access group {policy-id}.

The response of the method returns an array of strings with the addresses of the owners of the access group.

Response example:

GET /privacy/{policy-id}/hashes

The method is designed to get an array of identification hashes of data that are bound to the {policy-id} access group.

The response of the method returns an array of strings with the identity hashes of the access group data.

Response example:

GET /privacy/{policyId}​/getData/{policyItemHash}

The method is designed to retrieve a packet of confidential data of access group {policyId} by the identification hash {policyItemHash}.

The response of the method returns the hash sum of the confidential data.

Response example:

GET ​/privacy​/{policyId}​/getInfo​/{policyItemHash}

The method is designed to retrieve a packet of confidential data of access group {policyId} by the identification hash {policyItemHash}.

The method response returns the following data:

  • sender - an address of confidential data sender;

  • policy_id - a confidential data group identifier;

  • type - type of confidential data (file);

  • info - массив данных о файле: filename - имя файла; size - размер файла; timestamp - временная метка размещения файла в формате Unix Timestamp (в миллисекундах);

  • author - file author;

  • comment - optional comment to the file;

  • hash - confidential data identifying hash.

Response example:

POST /privacy/forceSync

The method is designed to force a packet of confidential data. It is used if a transaction with confidential data for an access group is present in the blockchain, but for some reason this data was not written to the node’s confidential data repository. In this case, the method allows to forcibly download the missing data.

The response includes the following data:

  • sender - address of the node participating in the access group that sends the request;

  • policy - a confidential data group identifier;

  • source - address of the node from which the missing data should be downloaded. In case the node is unknown, set the parameter to null or leave the field empty: in this case the file will be downloaded from the storage of the first node in the access group list.

Method response contains a result field with data retrieval result and message field with possible error text. In case of successful reception, success is returned, confidential data is written to node storage.

If an error occurs, error is returned, the message field contains a description of the error.

Examples of a query and a response:

POST /privacy/getInfos

The method is designed to obtain an array of confidential data metadata by access group identifier and identification hash.

The response includes the following data:

  • policiesDataHashes - an array of data with two elements for each individual access group: policyId - access group identifier; datahashes - an array of sensitive data hashes to get metadata for each of them.

The method response returns an array of data for each individual hash of sensitive data, similar to the response of the GET /privacy/{policyId}/getInfo/{policyItemHash} method.

Examples of a query and a response: