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 https://proofspace.atlassian.net/wiki/spaces/PSM/pages/2133786630.
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 (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 initiation 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, select the desired interaction's name and click "Embed" tab 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).
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.
An extension is a set of webhooks that provide extended functionality for your service to interact with external systems.
To use the extention in your interactions, first step is to install this extension in your service. If the extension has already been installed, you can add it to the interaction.
To install a new extension to your service, follow these steps:
Navigate to the "Extensions" tab in the main menu.
Click "Install extension."
Select the "Public Extensions" or "My Extensions" tab in the pop-up window and click “Install” next to the chosen extension.
Add extension to the interaction
Navigate to the “Interactions” tab in the main menu, select the desired interaction, and then go to the “Extensions” tab. Click “Select.”
In the “Extension Settings” pop-up window, click “Add” next to the desired extension. If the selected extension requires additional settings, fill out the corresponding fields.
Provide all necessary information and click “Submit.” If the extension requires credentials, such as the DID of the integrated SSI platform, it will be automatically added to this interaction.
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:
Go to the “Interactions“ tab.
Select the interaction where you want to add the webhook.
Click the “Details“ tab.
Click on the “Web hook“ field.
In the “Edit web hook“ pop-up window, enter the URL of the endpoint that will receive the webhook request.
Select the key. By default, this webhook will use the default service key t generated during the approval of your service. This key authenticates the webhook request and ensures it comes from a trusted source.
Choose the authentication type. Note that the key type "SHA secret" can be used only with the auth type "Bearer Token."