Embedding Raptor

The Raptor Document Warehouse can be embedded in any application, either by loading in an iframe and sending context over javascript messages, or simply by passing the context in the URL.

Embed using URL parameters

To embed Raptor via URL, you can use query parameters "exa-auth-plugin" en "exa-plugin-context".

Example on how to create the url:

//1. The external system token (see /api/user/getusertoken)
var authToken = "xxxxx"; 

//2.The business context
//Use parameters "source", "type", "fields" and "legalEntity" to resolve a context tag
//using entity configuration (see /api/integration/resolvecontext)

//Use the "options" to toggle various options when embedding Raptor

//Use the "documentFilter" to preload Raptor using a fixed query

var context = { 
   "source": "D365-FO",
   "type": "VENDVENDORV2ENTITY",
   "fields": {
      "VENDORACCOUNTNUMBER": "V00001",
      "VENDORORGANIZATIONNAME": "Spotmeyer's Furnishings"
   },
   "options": {
      "mode": undefined, //use "compact" for compact mode
      "disable-context-detach": false,
      "disable-upload": false,
      "disable-download": false,
      "disable-view": false,
      "disable-email": false,
      "disable-copy": false,
      "disable-delete": false,
      "disable-external-src": false,
      "disable-documenttriggers": false,
      "disable-tenantname": false,
      "readonly-mode": false
   },
   "documentFilter": {
      "name": "My documents",
      "query": { "operator":"document.uploader.self" }
   }
};

var url = new URL('https://raptor.9altitudes.com')
url.searchParams.append('exa-plugin-context', JSON.stringify(context));
url.searchParams.append('exa-auth-plugin', authToken);

url.toString();