Product Integration APIs

This section describes the REST API that can be used to integrate Digital Fax and third party systems, making them capable to automate fax-related activities.

Base URL & Authentication

• Base URL:

  CODE

  https://{host}/fw/Apps/StoneFax/WebAPI/

  • The {host} variable represents the UCX Suite server hostname or IP address.

• Authentication:
  All endpoints require HTTP Basic Authentication. You must include an Authorization header with your username and password encoded in Base64.

  Example header:

  CODE

  Authorization: Basic {base64(username:password)}Postman samples

Supported APIs list

• Submit Fax

• Get Outbound Fax Details

• Download outbound fax document

• Get Outbound Faxes List

• Get Inbound Faxes List

• Get Inbound Fax Details

• Download Inbound fax document

Below attached ZIP file contains a json collection file that you can import into Postman. It includes some samples useful to understand how to invoke with Postman the relevant API methods.

Imagicle StoneFax API.postman_collection.zip