Overview

What is Data Sharing Datahub API

Use the Data Sharing API from Scalar to share asset data of one SCALAR organization with other SCALAR organizations. You can create new framework agreements for both existing and non-existing SCALAR organizations. To accomplish this, follow these steps:

• Create Framework Agreements
• Create Contracts
• Create Sessions

Framework Agreements

You can create framework agreements for both existing and non-existing SCALAR organizations. A Framework Agreement includes essential details such as:

• Identity of the data provider and data consumer, Data sharing preferences, Entity details (asset/unit), Contract preferences, Value propositions and payer details. Consumer details are retrieved using the consumer’s shared OTP (One-Time Password/Passcode).
• Users can also onboard consumer organizations to SCALAR while creating a framework agreement if the consuming partner does not exist in the SCALAR. In this case:
  • The agreement includes provider identity, data sharing preferences, entity details, contract preferences, value propositions, and payer details (provider acts as payer).
  • The Consumer basic details such as first name, last name and email address are used to onboard the partner organization.
  • User can also choose profiles from his own organization and assign it to consumer organization for consistency.

Contracts

Contracts define how many assets can be shared with another organization. The system enforces the asset count specified in the contract. Users cannot assign more assets than the agreed limit.

Sessions

Create a session by selecting the list of assets to share with consumer organizations. Each asset will have an individual session created for tracking and management.

Why use Data Sharing?

Purpose I: Manage Framework Agreements

SCALAR allows you view and manage Framework Agreements. You can fetch list Framework Agreements or a specific Framework Agreement by providing a specific ID and create new Framework Agreements.

Purpose II: Manage Contracts

SCALAR allows you manage contracts. You can create contracts and retrieve list of contracts or a specific contract by providing specific ID and create contracts.

Purpose III: Manage Sessions

SCALAR allows you manage sessions. You can retrieve list of sessions or a specific session by providing specific ID, create contracts, and update details of sessions.

Purpose IV: Manage Actions

SCALAR allows you manage actions. You can stop framework agreements, stop contracts, start and stop sessions, extend contracts, approve or reject framework agreements.

Purpose V: Retrieve profile details of an organization

SCALAR allows you retrieve profile ID and name of an organization.

Use Cases

Use case I: Creating framework agreements

• New framework agreements are created for the specific organization. The framework Agreement includes basic details such as the identity of the data provider and data consumer, data sharing preferences, the entity (asset/unit), and payer details.
• For inviting consumers, users can choose a preconfigured profile to onboard consumers. If a user wants to onboard their partners to SCALAR, they can use DATA SHARING framework agreement.

Use case II: Creating contracts

Create new contracts for data sharing.