integration

Integration

Integration is an easy way to connect an external party to the Valuation service at Valueguard.

Steps to Build and Use the Integration

The services currently work with OAuth authentication and a so-called “project,” which is the core component of the service. Company X needs to store the credentials for Valueguard and map its internal user parameters to our project structure. The client can then be forwarded to the Valuation service and work within the project.

We also support the option to retrieve the finished report, either by the company on their side or via a company-specific solution with an in-application upload button.

1. Store the Customer’s Credentials

You'll need the user's credentials. These can be stored as a refresh_token or simply as a username/password in the client’s settings.

To obtain the initial refresh_token, a callback solution can be used where the redirect URL is specified in the callback parameters, prompting the client to log in for the first time.

1. Update the redirect URL to point to your server. (Note: This must be approved by us beforehand.)

https://auth.valueguard.se/authorize?response_type=code&client_id=GQAvJLv0BLhSuH86RqOItCDr9IDzPcyp&redirect_uri=https://valueguard.se/callback&scope=openid%20profile%20email

2. A callback will be triggered with a code, which can then be exchanged for an access_token and refresh_token.

Read more under Authentication/Code in the wiki.

2 Project

2.a Creating the Project on Your Side

Each project, which serves as the foundation of the valuation experience, can be filled in and sent as a parameter with the project.
The structure of a project can be found in the documentation.

Note: If an empty project is submitted, the user will start fresh.

The URL to use here is:
https://analytics-prod.valueguard.se/auto-login?access_token={access_token}&project_id={project_id}

2.b The Project is Created by Valueguard (Integration-Specific Solution)

If project creation should be handled by Valueguard,
only the integration_type and integration_id need to be provided to get the project_id.

3 (Optional) Uploading the PDF to Your System

3.a Download from Your Side

With the access_token and project_id, the PDF can be downloaded via the instructions here

3.b Use the Upload Button in the App (Integration-Specific Solution)

An upload button can be embedded within the service to allow clients to upload the finished report directly, although it will require a company-specific solution.