The mode, company & scriptSet attributes provided within the examples below would need to be updated & configured correctly to match your Keyfax configuration. Please contact Omfax Systems for assistance preparing your Keyfax start-up data.
The minimal start-up data required in order for Keyfax to return launch data is shown below. These examples are only provided for demonstration purposes and start-up data should be tailored to suit your environment & integration.
You would pass start-up data into POST /api/v1/startup to obtain Keyfax launch data allowing you to launch a Keyfax session. Example minimal start-up data in both JSON & XML is provided below.
Whilst you will always need to provide a minimal set of start-up data it's also possible to post custom start-up data into Keyfax. This custom start-up data can be used within Keyfax to provide dynamic or intelligent scripting. Any supplied custom start-up data can also be flowed through Keyfax and made available again within the final results produced by Keyfax when calling POST /api/v1/results.
The example start-up JSON below demonstrates how to include custom data within the request to POST /api/v1/startup via the Keyfax Web API JavaScript SDK...
The example C# code below shows how to build this same custom start-up data using the strongly typed Keyfax Web API .NET SDK...
// Build a sample JSON payload, values are hard coded as this is for demonstration purposes only
var startUpData = new StartUpData()
{
Mode = new StartUpDataItem()
{
Value = "RD"
},
UserName = new StartUpDataItem()
{
Value = "administrator"
},
Password = new StartUpDataItem()
{
Value = "Global"
},
Company = new StartUpDataItem()
{
Value = "RDFL_Dev"
},
ScriptSet = new StartUpDataItem()
{
Value = "RD"
},
CustomData = new StartUpDataItem()
{
Key = "CustomData",
Children = new List<StartUpDataItem>()
{
new StartUpDataItem()
{
Key = "CustomFields1",
Children = new List<StartUpDataItem>()
{
new StartUpDataItem()
{
Key = "CustomField1",
Value = "Child Example Value 1"
},
new StartUpDataItem()
{
Key = "CustomField2",
Value = "Child Example Value 2"
}
}
},
new StartUpDataItem()
{
Key = "CustomFields2",
Children = new List<StartUpDataItem>()
{
new StartUpDataItem()
{
Key = "CustomField1",
Value = "Child Example Value 1"
},
new StartUpDataItem()
{
Key = "CustomField2",
Value = "Child Example Value 2"
}
}
},
}
},
};
Start Up Data Examples
Below we've provided several examples showing the start-up data you would typically supply to Keyfax. These are just examples to help demonsteate what's possible. The start-up data you provide to Keyfax would typically be customized based on your integration.
The below illustrates some realistic start-up data you would typically post to Keyfax via /api/v1/startup. This is only to serve as an example and to show what's possible. Host systems would typically work with Omfax Systems to craft this start-up data based on your specific requirements & configuration.
So to access values within the <CustomData/> element you can use XPath expressions within existing Import data boxes as shown below...
Exporting Custom Start-Up Data
If you supply custom start-up data and wish to expose this within results produced by Keyfax the export template used by Keyfax will need to be updated to include any custom start-up data.
We would always suggest contacting Omfax Systems to better understand your requirements. We will work with you to tailor your start-up & export data to suit your integration and ensure you get the most from Keyfax.
