Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

The ProofSpace platform provides various integration options, including deep and web links, data and status exchange through webhooks, and the configuration of webhook sets, which we call extensions. Additionally, it allows for additional data verification in a third-party system and the issuance of credentials through webhook calls. For more detailed information, see Integration Webhooks API Overview.

Features

Description

Screenshots

Integrate with ProofSpace platform services via Deep and App links.

Pre-filling credential data from QR code

The ProofSpace mobile application provides functionality to handle calls from third-party mobile applications via Deeplinks (Mobile deep linking) and Web Links (call the native application from a web page). 

Both options can initiate the ProofSpace app to execute a specified interaction and pre-fill the attributes of self-attested credentials (if needed).

The ProofSpace app also supports callbacks to the requesting side after successfully executing these interactions.

To find an example of a QR-code format that can be embedded on your website to enable the initialization of particular interaction, go to the "Interactions" page, select a particular interaction with initiation media “QR“ and click the "QR codes and deeplinks" button. Then, select the desired interaction's name and click "Embed" on the new window.

To set up an interaction that can be initiated from a third-party service via Deep or Web link, select "QR code" as the initiation media for the interaction (1). 

Then, choose the self-attested credential that needs to be pre-filled from the QR code (2).

Then, click on the chosen required credential (3) and select the "Pre-fill from QR" checkbox in the "Edit required credential" pop-up window.

Note that attribute data pre-filled in this way (via the QR code) will not be editable in the app.

You can find more information on how to integrate third-party applications and websites with ProofSpace services through App and Deep links here.

The ProofSpace mobile application offers functionality to handle calls from third-party mobile applications via Deeplinks (Mobile deep linking) and Web Links (calling the native application from a web page).

Both options can initiate the ProofSpace app to execute a specified interaction and pre-fill the attributes of self-attested credentials, if needed.

The ProofSpace app also supports callbacks to the requesting side after successfully executing these interactions.

To find an example of a QR code format that can be embedded on your website to enable the initialization of a particular interaction, go to the 'Interactions' page, select a specific interaction with the initiation media 'QR,' and click the 'QR codes and deeplinks' button. Then, choose the desired interaction's name and click 'Embed' on the new window.

To set up an interaction that can be initiated from a third-party service via Deep or Web link, select 'QR code' as the initiation media for the interaction (1).

Next, choose the self-attested credential that needs to be pre-filled from the QR code (2).

Finally, click on the chosen required credential (3) and select the 'Pre-fill from QR' checkbox in the 'Edit required credential' pop-up window.

Extension(s)

An extension is a set of webhooks that provide extended functionality for your service to interact with external systems.

 

Install extension

First step is to install an extension to your service. If the extension has already been installed, you can add this extension to the interaction.

To install a new extension to your service, follow these steps:

  1. Navigate to the "Extensions" tab in the main menu.

  2. Click "Install extension."

  3. Select the "Public Extensions" or "My Extensions" tab on the pop-up window and click “Install” next to the chosen extension.

Add extension to the interaction

Click the “Interactions“ tab of the main menu and select the interaction to which you want to add the extension. On the next page, click the “Extensions“ tab and there, click “Select.“

On the “Extension Settings” pop-up window, click “Add“ next to desired extension. If the selected extension requires additional settings, you will see the corresponding fields to fill out.

Add all the required information in the appropriate fields and click “Submit.“

If this extension requires credentials, for example DID of the integrated SSI platform, it will be added automatically to this interaction.

 

Web hook

Setting up a webhook allows you to send the client's data from this interaction to a third-party system (such as a CRM).

To do so:

  1. Go to the “Interactions“ tab.

  2. Select the interaction where you want to add the webhook.

  3. Click the “Details“ tab.

  4. Click on the “Web hook“ field.

  5. On the “Edit web hook“ pop-up window, enter the URL of the endpoint that will receive the webhook request.

  6. Select the key. By default, this webhook will use the default service key that was automatically generated when we approved your service. This key will be used to authenticate the webhook request and ensure it comes from a trusted source.

  7. Select the authentication type. Please note that the key type "SHA secret" can be used only in auth type "Bearer Token."

Click “Submit.“

For more information, visit the key page of this overview and Interaction Webhooks API Overview.

  • No labels