FaxLogic Fax API for Developers

With the FaxLogic Fax API, you can send a fax using a simple HTTPS POST request. POST fields let you set the parameters of your request. At a minimum, you may define one or more fax recipients and one or more documents that you want to fax. For each recipient, you may set the recipient's name, fax number, phone number, organization and reference values. For each document, you may POST the file data in your request, or you may specify a URL where FaxLogic can retrieve your document. FaxLogic supports most popular file formats, including Microsoft Office documents, PDF documents and common image files, such as BMP, GIF, JPEG, PNG and TIFF.

Other parameters let you select a predefined cover sheet, set the message subject that appears on the cover sheet, and set the transaction token used to find all the messages associated with a particular transaction. Also, you may supply form data that FaxLogic uses to populate the cover sheet and any other PDF forms that you want to fill.

Additional parameters let you define asynchronous event callbacks and notifications. Then, as it processes a fax, the FaxLogic system can deliver progress information to your callback URL's via HTTP/S POST, and it can send system messages to one or more notification e-mail recipients that you specify.

Once a message has been created in the FaxLogic system, you can use the FaxLogic Fax API to retrieve structured metadata for the message. Message data includes recipients, delivery status, usage fees and other message properties.

Using the FaxLogic Fax API, you can download original and recipient-specific versions of a fax as PDF or TIFF documents. For a given message, the "original" fax document reflects the files that were submitted with the request before any form fields were filled. For example, a cover sheet will be unfilled in the original version of a fax. A recipient-specific fax document shows the fax as it was delivered to one recipient, with recipient and other form data inserted, where appropriate.

For each fax recipient, the FaxLogic system generates a transmission report that details the pertinent information about the fax delivery, including sender and recipient information, delivery result, and a preview image of the first page of the fax. Using the FaxLogic Fax API, you can download these reports as PDF or TIFF documents.

The FaxLogic system automatically indexes information about your fax messages, enabling basic keyword searches, as well as sophisticated Boolean searches. The FaxLogic Fax API supports the same search functionality as the FaxLogic Advanced Web Client, so finding messages in the FaxLogic system is as easy as providing an appropriate search string. After executing your search request, the FaxLogic Fax API returns a summary of the messages matching your search criteria.

The FaxLogic Fax API lets you delete an entire message and its media, or you can delete just the media. Deleting the media reduces online storage consumption, while retaining message history.

FaxLogic Fax API connectors allow you to create and configure different profiles for development, staging and production. Connector properties, as well as user and online storage mappings, for each profile can be tailored to each connector's purpose.

A FaxLogic message store is an online repository for fax messages. Like an e-mail mailbox, a message store provides standard folders for inbound and outbound messages, plus user-defined folders for organizing your messages. Each FaxLogic Fax API connector can map to one or more message stores. Mapping a connector to multiple message stores creates a copy of each new message in each message store, allowing you to route messages to multiple users, archive messages in backup message stores and monitor system usage for abuse.

FaxLogic contact stores allow you to manage your contacts within the FaxLogic system. Mapping contact stores to a FaxLogic Fax API connector enables automatic contact lookup and linking of fax recipients, ensuring that consistent recipient information (i.e. name, company, phone, etc.) appears on cover sheets and transmission reports.

FaxLogic Fax API connectors support a rich set of properties, letting you customize the way FaxLogic operates. For example, connector properties allow you to select the FaxLogic Fax API response format, create barcode scanning and data collection profiles, define cover sheets, set a connector's Called Subscriber Identification (CSID) value, customize fax header information, and much more.

Each FaxLogic Fax API customer gets a unique subdomain. All FaxLogic Fax API requests to a customer's subdomain must be authenticated for that subdomain.

The FaxLogic Fax API uses a keyed-HMAC (Hash Message Authentication Code) for authentication. Keyed-HMAC authentication uses a cryptographic hash function and a secret shared key to calculate the authentication signature required by each API request. Using elements in the request, the FaxLogic system generates its own signature and compares it to the signature provided in the request. If they match, the FaxLogic system concludes that the requester possesses the secret key and allows the request to proceed; otherwise, the request fails with an error.

All FaxLogic Fax API requests use Secure Sockets Layer (SSL) connections, to prevent unauthorized access or eavesdropping of data as it traverses the network.

Each FaxLogic Fax API request requires a timestamp that must be accurate to +/- 15 minutes of the FaxLogic system time. If the timestamp on a request exceeds the acceptable time window, the request fails. Time skew detection prevents "man-in-the-middle" replay attacks, using otherwise-valid request data. Also, the timestamp is a required part of the authentication signature, which prevents hacking of the timestamp value.