API SDKs
Learn how to use the Keyfax Web API .NET or JavaScript SDK's.
Last updated
Was this helpful?
Learn how to use the Keyfax Web API .NET or JavaScript SDK's.
Last updated
Was this helpful?
To ease integrations Omfax Systems would recommend leveraging the provided Keyfax Web API SDK's whenever possible. The Keyfax Web API SDK's provide a higher level abstraction around the Keyfax Web API and ease consuming the various API end points. Currently Omfax Systems offer both a .NET & JavaScript SDK.
Our .NET SDK is suited towards .NET based desktop applications or ASP.NET based web applications. Our JavaScript SDK is suited more for client side browser applications or single page applications (SPAs) or applications where it's not possible to safely secure your Keyfax Web API signing key.
If you are consuming the Keyfax Web API using a language other than .NET or JavaScript you will need to develop your own code to verify requests into the Keyfax Web API. For further information on how requests are verified and all available API end points please see "The Keyfax 1.0 REST API - A Host Integration Guide"..
The Keyfax Web API SDK Explorer is only accessible when Keyfax is running locally via localhost or 127.0.0.1. For security reasons this page is not accessible when running Keyfax within a non-local environment.
If you are working with Keyfax 4.3.3.0 or above you can point your development web browser to /Interview/Utilities/WebApi/. If you are running Keyfax locally this will present a page demonstrating both the .NET & JavaScript Web API SDK's. On this page you'll notice two tabs along the top - a ".NET SDK Test Bed" tab and a "JavaScript SDK Test Bed" tab. Developers working with the Keyfax Web API SDK's may find the code in these examples helpful. If you would like access to the SDK test page to assist with your integration please contact Omfax support.
You can see an example of the Keyfax Web API SDK test page below...
Learn More
