Adding external links to the RealEquity user interface and retrieving context information

General API
, ,
1

Integration partners can leverage System Extension products to add external links to the RealEquity user interface. The links can be added to the Agent Universe, in which they can be made visible on the global create menu and the jump functions menu of the case.

The global create menu is used when creating e.g. cases, contacts and referrals. The jump menu of the case is used specifically on the dashboard of the case.

It’s possible to add an SVG icon to each of the external link menu items.

The System Extension product, and it’s related product package, will be created by C&B staff. Since the product and product package is part of the Partner Hub framework, it’s possible to benefit from the configuration options already available in the latter. For example, it’s possible to control that the extension enabling the external link(s) is only made available to specific resource groups that are allowed to install and use the product package.

Retrieving context information using an external link

When the system extension is configured, it will contain one or more links pointing to external urls. Each link will be displayed in either the global create menu or the jump menu of the case.

When a user (an agent) uses an external link, a query parameter redirectcontext is appended to the url specificed in the extension as the HTTP GET request is made. In the following example, the parameter has been appended to the specified url https://www.cb.dk/.

Example:

https://www.cb.dk/?redirectcontext=d9e08223-8d7d-4f30-a422-d99b3cd8d28b

:information_source: The guid value of the redirectcontext parameter is valid for 1 minute only.

Immediately upon receiving the request, an no later than one minute thereafter, the external resource is able to perform a reverse lookup by returning the value of the redirectcontext query parameter as a path parameter to the following end point in the RealEquity API:

~/api/redirectcontexts/d9e08223-8d7d-4f30-a422-d99b3cd8d28b

The end point will return context information about the actor, who clicked the external link, the resource group of the actor and optionally also the case from which the link was clicked.

:information_source: No case information will be provided if the link is clicked from the global create menu.

{
    "actor": {
        "id": "cfcb1312-68f5-4e2d-a4af-b526fbf68891",
        "displayName": "Jens Jensen",
        "email": "jens.jensen@cb.dk"
    },
    "resourceGroup": {
        "id": "4cf2956b-d04d-465d-aecf-960152e7248d",
        "displayName": "C&B Mægler Demo"
    },
    "case": {
        "id": "38103207-3441-4e88-a8ff-f1d0d72fd928",
        "displayName": "ABC1 - Arresøgårds Sidealle 14, Ramløse, 3200 Helsinge"
    }
}
1 Like