Retarus Faxolution for Applications Webservice

Retarus Faxolution for Applications Webservice streamlines the automation of fax transmissions. It also enables you to monitor the status of sent faxes and delete archived reports. The webservice uses REST 1.0 (JSON) and is programming language agnostic, allowing you to implement the client in any language.

Fax Transmission Workflow

Fax transmission typically follows these steps:

1. Create and send a fax job to the webservice.
2. Retrieve completed fax jobs:
   • List all completed jobs:
     GET /{custNr}/fax/reports
   • Get status details:
     • Individual job: GET /{custNr}/fax/reports/{jobId}
     • Multiple jobs: POST /{custNr}/fax/reports
3. Delete retrieved jobs:
   • Individual job: DELETE /{custNr}/fax/reports/{jobId}
   • Multiple jobs: POST /{custNr}/fax/reports

Alternatively, you can receive fax job status updates via HTTP push and/or email. Fax job data is automatically deleted after the configured retention period.

High Availability (HA) Regions

For maximum reliability, Retarus operates two high-availability regions, each with clustered data centers:

• Germany (HA region DE):

  • DE1: Frankfurt Data Center
  • DE2: Munich Data Center

• United States (HA region US):

  • US1: Ashburn Data Center
  • US2: Secaucus Data Center

Refer to the specific API operations for guidance on using HA settings.

Test Account

To start using the Retarus Faxolution for Applications Webservice, you need an active account. If you don’t have one, you can request a test account to explore the service and integrate it into your applications.

The test account gives you access to all key features, allowing you to send test faxes, monitor status updates, and evaluate the API’s capabilities before moving to a production environment.

To request a test account for this or any other Retarus fax service, please contact Retarus.