DOCMAIL: API

Docmail Fair Usage policy:

Please read our Fair Usage policy (on our Terms of Business page, middle column)which defines 'best practice' for integrating with our API. Here's the link:

www.docmail.co.uk/tob

Docmail API 2.0 Help Guide

Download the full Web Service Help Guide to learn how to integrate your application with Docmail.

NB: Use of the Docmail logo is not permitted without authorisation from CFH Docmail Ltd

Docmail API Access Questionnaire

IMPORTANT! Please fill out the questionnaire below and return to:

CUSTOMERSUPPORT@CFH.COM

WELCOME TO THE NEW AND IMPROVED DOCMAIL PHYSICAL MAIL API!

As ever, Docmail's secure API (Application Programming Interface) allows you to send A4 letters, Postcards, Greeting Cards and Business Cards (corporate only) 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 (subject to status, volume and regularity of orders).

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

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.

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. ▲Top...

DOCMAIL WEBSERVICE DEFINITIONS

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

▲Top...