Docmail API

Discover how to integrate your system with Docmail's API, enabling you to streamline business processes and send secure documents quickly and cost-effectively.

Docmail's secure API (Application Programming Interface) allows you to send A4 letters, Postcards and Greeting Cards from a click of a button within your own computer systems.

Docmail creates a hybrid of electronic and physical mail by transmitting an electronic document and mailing list to us, where we print and mail it as real post.

The Docmail API allows you to add a Hybrid Mail service right into your own systems and workflows.

BASICS OF THE DOCMAIL API

The API is a SOAP-based webservice allowing the creation, proofing and confirmation of orders for mailings, single letters, postcards and greeting cards. Documents (PDF, RTF or Word files) are submitted as files or selected by name from your account. 

Address lists may be selected by name, submitted as a file (CSV, XLS, XLSX, Tab delimited, fixed length fields etc.) or added as individual addresses using the AddAddress call.

A PDF proof approval is available, but is no longer a required step in the process.

Payment is made via Top-Up credit on the customer Account, or for large volume users, payment on invoice may be available.

Examples in the API documentation are based around Microsoft Visual Basic .NET code. 

DOCMAIL TEST ENVIRONMENT

Docmail provides a separate testing environment for use with the API. It provides the same API, and web functionality as the live system, with a website mirroring the live version. We do not produce any print or mail output from the test environment and any credit has no cash value. Credit in the test system can be topped up from the Account Admin section of the test website without charge.

The test environment uses separate databases, so your live login details don't apply. Likewise, your test login credentials are not available for use in the live environment.

Docmail test system access: https://www.cfhdocmail.com/test/

Docmail test system signup: https://www.cfhdocmail.com/test/signup.aspx

Docmail test API wsdl: https://www.cfhdocmail.com/TestAPI2/DMWS.asmx?wsdl

Docmail test API definition: https://www.cfhdocmail.com/TestAPI2/DMWS.asmx

Feel free to browse & access the test website and test with the API, remembering that to send any live mailings, you'll need to switch your credentials to your live account and the webservice URL over to the live address, shown below.

DOCMAIL WEB SERVICE DEFINITIONS

Webservice definitions for the API are available at these URL’s:

https://www.cfhdocmail.com/TestAPI2/DMWS.asmx?wsdl

https://www.cfhdocmail.com/TestAPI2/DMWS.asmx

https://www.cfhdocmail.com/LiveAPI2/DMWS.asmx?wsdl

https://www.cfhdocmail.com/LiveAPI2/DMWS.asmx

Was this article helpful?