Appendix B – Customization

Web Services API

Introduction

This section illustrates the HTTP/XML communication between the FF240-IP Web Service (FFWS) and a client. FFWS provides an interface to the FF240-IP units for client applications. Client applications can use FFWS for sending faxes, managing contacts and monitoring fax status.

Authorization

All request requiring authorization must have the Authorization header set using Basic authentication. If this is not set or the username or password are incorrect then “401 Unauthorized” is returned.

See RFC 2617 for implementation

HTTPS

The server supports HTTPS. Secure requests can be sent to the default HTTPS port 443.

Creating a new fax

An application can schedule a fax by posting the schedule fax XML to the ofax resource. If the fax is successfully scheduled then a response is returned with the scheduled entries.

Each file that you wish to attach as fax pages must be placed in an attachment element. An "inline" attachment is an attachment with the contents of the file inserted into the content tag. Inline attachments must be encoded using base64. The name of the attachment can usually be set to the basename of the file unless that name is not unique among the attachments. The name is used primarily for error responses, so if you would like to know the attachment which failed then it is important to make this field unique. The content type of the attachment should be set to match the type of file being transferred. For example, if you are attaching a PDF, then the content type should be set to "application/pdf". It is important to properly set the type because this field is used when converting the file into fax pages. No attempt is made to guess the content type on the server.

Limits

Request size: 2MB for [12]30, 5MB for [48]30

Maximum Recipients per Fax: 400

Query Parameters:

None

HTTP Request line:

POST /ffws/v1/ofax HTTP/1.1

HTTP Response Status Codes:

201 Created

The fax has been created successfully.

400 Bad Request

Invalid request. The fax has not been scheduled. A more verbose message may be provided in the response message if possible.

Multi-Tech Systems, Inc.

FF240-IP Admin User Guide

95

Page 94 Page 96
Page 95
Image 95
Multitech FF240 manual Appendix B Customization, Web Services API, Introduction, Authorization, Creating a new fax
Page 94 Page 96

FF240 specifications

The Multitech FF240 is a versatile and powerful device designed to address a wide range of applications in the realm of IoT (Internet of Things) connectivity. This robust product is engineered to facilitate reliable communication over various wireless networks, making it an ideal choice for industries like agriculture, smart cities, environmental monitoring, and asset tracking.

One of the standout features of the FF240 is its support for multiple connectivity options. It is equipped with best-in-class LoRaWAN technology, which allows for long-range communication with low power consumption. This means devices in remote areas can send data back to a centralized location without the need for extensive infrastructure or battery replacements. Additionally, the FF240 supports cellular connectivity through LTE, which ensures that it can maintain connectivity even in situations where LoRa signals may be weak.

The device boasts a compact and rugged design, making it suitable for deployment in harsh environments. The FF240 is built to withstand extreme temperatures, moisture, and dust, ensuring operational integrity in a variety of scenarios. Its IP67 rating further reinforces its reliability, allowing it to be used in outdoor applications without fear of damage from the elements.

In terms of functionality, the Multitech FF240 offers an array of features, including local processing and data aggregation capabilities. This device can process sensor data on-site, reducing the amount of data transmitted and thereby optimizing communication bandwidth. This capability is particularly beneficial for applications requiring real-time monitoring and quick response times.

Moreover, the FF240 is designed with cloud connectivity in mind. It integrates seamlessly with various cloud platforms, providing users with the ability to track and manage their devices remotely. This capability enhances operational efficiency, as users can monitor performance metrics and make data-driven decisions based on real-time insights.

Security is a paramount concern in IoT deployments, and the Multitech FF240 addresses this with robust encryption protocols. With secure authentication and data security measures in place, users can have peace of mind knowing their data is protected.

In summary, the Multitech FF240 stands out due to its multi-network support, durable design, local processing capabilities, cloud connectivity, and advanced security features. It is a comprehensive solution that caters to a wide range of industrial applications, empowering businesses to leverage IoT technology for improved efficiency and innovation.
Top Page Image Contents