Integrating with Appraise-It Pro

Before writing an integration, make sure you've enabled the Development tab for access to the Field Details Pane and the integration web browser.

---

Appraise-It Pro exposes useful functionality to web-based applications through its CefSharp web browser.

A JavaScript binding object allows Appraise-It Pro to communicate with a web page. Data can be read from the current report, downloaded from a provided URL, or imported directly from JavaScript.

Writing a Web Integration

With the Development tab enabled, Show Integration Web Browser is accessible, along with an option to launch the browser with Chromium DevTools enabled.

By default, the integration web browser loads a sample web page that demonstrates the capabilities of the JavaScript binding object.

Initializing the Web API

To initialize the API on your own website, make the following call.

await CefSharp.BindObjectAsync("IntegrationSampleJavascriptObject");

This usually works best when done during page initialization.

Note that if you are creating an official third-party integration, you will be issued a unique object name by the SFREP development team when your application is added to Appraise-It Pro's ribbon menu.

Redirecting the Integration Web Browser

You can set a registry key to redirect the integration web browser to point to your own website.

Key: HKEY_CURRENT_USER\Software\SFREP\Appraise-It Pro\Development
String Value:
    Value name: BrowserIntegrationUrl
    Value data: your URL

Removing this value will repoint the integration web browser to the local sample web page.

Authentication and Caching

Authentication within the browser is supposed using cached OAuth credentials.

You can point the browser at your standard user login page; the user will log in normally, and any access tokens and authentication cookies will be cached as with any other Chromium-based browser.