TEC Mailing Solutions LLC (WS)

Version 3.0

4/17/2018

TEC Mailing Solutions LLC (WS API)

Remarks

Introduction


 The TEC Mailing Solutions Web Service API is an Application Programming Interface, which allows you to connect your application with TEC Mailing Solutions’ web interfaces. Using the Web Service API, you can seamlessly process address files through a number of services directly in your application.

 The TEC Mailing Solutions Web Service API is a SOAP-based web service. Some of the advantages of offering integration using a web service include:


 • Platform independence — Any application that can send and receive SOAP messages can communicate with the Web Service API. Because the Web Service API is built using open standards, you can choose any technology that suits your needs (e.g. J2EE, .NET, PHP, ASP, etc.) for integrating with the TEC Mailing Solutions Web Service API.


 • Ease of integration — Communicating with a web service is simple. Your application builds a SOAP request message encoding your transaction, sends it via HTTPS to the web service, and waits for a SOAP response message, which contains your transaction’s status. Since SOAP and HTTPS are designed to be lightweight protocols, building requests and parsing responses is a straightforward. Furthermore, rarely do you have to do this manually, since there are a number of libraries available in almost every technology. In general, building a SOAP request and handling the response is reduced to a few lines of code.


 • Security — All communication between your application and TEC Mailing Solutions Web Service API is SSL-encrypted. Your application has a client certificate, which identifies it uniquely with the web service. The Web Service API holds a server certificate, which your application checks to ensure that it is communicating with the Web Service API. The Web Service also requires HTTP basic authorization (user name and password) in order to communicate with the web service. These security mechanisms guarantee that the transaction data sent to TEC Mailing Solutions Web Service API stays private and is available only to your application.


 This document will assist you in integrating your application with the Web Service API, and provide you with a brief summary of the Web Service API solution feature set.

How the API Works

The following section describes the process of creating a job and submitting data through the Web Service API.


 In most cases, a customer starts the overall communication process by identifying a particular process to be performed on their address data (example NCOALink and Dedupe) in your application or online environment.  Your application needs to send a transaction to TEC Mailing Solutions to establish a job.  Having received the transaction, the TEC Mailing Solutions Web Service API forwards it to the application servers within TEC Mailing Solutions’ data center.  Based on the defined processes, your application receives a status update or an error response from the Web Service API.

Web service interfaces are designed using the Web Service Definition Language (WSDL). The WSDL file for the Web Service API is located here:


See: End Points


 Note: Your user ID and password are not required to view the WSDL but they are required to access the TEC Mailing Solutions Web Service API.

The WSDL file defines the operations offered by the Web Service API, their request and response parameters, and how to call the operations. The TEC Mailing Solutions Web Service API WSDL file defines many operations, called by sending a SOAP request to the following URL:


This operation takes an XML-encoded transaction as a request and returns an XML-encoded response.  Depending on the tools you use to integrate with the Web Service API, you may need to provide the URL for the WSDL file. If so, you must tell your tool that the communication is SSL-enabled, provide your client certificate, and accept the server certificate as trusted. The process for this depends upon your tool. Consult the documentation for your tool for details.

Supported Tools

 The TEC Mailing Solutions Web Service API uses HTTPS and SOAP to communicate with your applications. As such, it is completely platform independent. The choice of languages, frameworks, or tools to integrate with the Web Service API is up to you.


 TEC Mailing Solutions has tested the Web Service API with the following tools:


• ASP.NET Framework

• C#.NET Framework

• VB.NET Framework

• PHP

• JAVA

While you can use any tools to integrate with the API, these are the tools TEC Mailing Solutions has tested.  Integrating with the TEC Mailing Solutions Web Service API using other tools is outside the scope of this document.

The Services Available

TEC Mailing Solutions has two high level methodologies available: Batch and Single Record.  Within each of these methodologies are a variety of services to clean, update, and sort address lists.

Batch:

The Batch method is intended to accommodate a complete file of address records.  In the case of address hygiene (NCOA) there is a minimum of 100 records.  For the presort process there is a minimum based on the class of mail (1st Class = 500 and STD = 200).  The web services do not support file sizes that exceed 2GB in the return dataset.  (See Return Dataset for more information) The services available in the batch method are:

1.       CASS

2.       NCOALink

3.       PCOA

4.       DSF2

5.       Deduping

6.       Presort

7.       Commingle Output

8.       Confirm Tracking (In conjunction with presort or standalone)

9.       Unique coding of records for IMb

Single Record:

The Single Record method is intended to accommodate one record at a time.  The services available in the Single Record method are:

1.       CASS Alone

The Environments

TEC Mailing Solutions has two environments that are available for developers ‘providers’ to utilize its Web Service API:  Customer Test Environment and Production Environment.  There are different endpoints and WSDLs for each location. 

When development has been completed in the CTE, new user credentials and endpoints must be used for the Production Environment.  All stored information such as entry points, Process Acknowledgement Forms (PAF), and Player information will not be available from one environment to another.

 Customer Test Environment (CTE):  The CTE is established in a location to allow new customers to build and test their applications utilizing the TEC Mailing Solutions Web Service API.  This environment is not intended to process any live production.  In this environment, only subsets of the actual output will be returned.  NOTE:  All jobs processed within the CTE environment will NOT be invoiced or billed to a credit card.

Production Environment (WS):  The production environment is the actual processing environment supporting the full host of services and methods of the TEC Mailing Solutions Web Service API.  NOTE:  All jobs processed within the production environment will be invoiced or billed to a credit card or an account.


Security

The customer test environment is intended to provide developers a location to establish connections, test WS calls and processing code.  It is not an environment to process live files.  Therefore, this environment has limited security and developers should treat as a “test” environment.  To access the customer test environment the developer will be required to have a user account, password, and UserDatabaseID.  All of these will be provided by TEC Mailing Solutions.

The production environment will require the provider (user\developer of the actual web service) a provider UserDatabaseID, Channel ID, and Product ID, and an Admin account.  Each user of the end product will be required to have a user account and password that is communicated through the web service.

Getting Started

How do I get started using TEC Mailing Solutions Web Service API?  All users of the Web Service API must contact TEC Mailing Solutions to obtain a customer account.  This process may involve a credit approval as well as the signing of a “Sales Contractor Agreement” and\or a TEC User\Subscription Agreement.

New Account Establishment:

Currently, all new users ‘providers’ whom are to use and develop under the TEC Mailing Solutions Web Service API must be manually created by TEC Mailing Solutions.  End users who are created under ‘Customers’ can be created by directing the user\developer via the AccountService.

Upon creation of a new account a developer (provider or customer) will be given the following values to describe the product being developed.  These values will be different from one environment to another.  These values are required for the purpose of end user account creation and must be implemented to access the Web Service API:

1.       userdatabaseid = A GUID identifying the provider or customer’s account

2.       channelid = A GUID identifying the service and/or business channel that is being utilized.

3.       productid = A GUID identifying the actual product/service group that is being utilized.

Additionally in order to test the web services an end user account must be established by TEC Mailing Solutions.  This account will be comprised of the following credentials:

1.       User Login

2.       User Password

End user account creation is available through TEC Mailing Solutions’ AccountService web service.  The AccountService supports the creation, and edit of end user accounts within a given userdatabaseid.


Products

TEC Mailing Solutions provides currently two products:  Batch and Single Record.  The end points are lists in the next sections and more information can be found for these services at:

BATCH Processing Endpoints

These endpoints may not currently be active and may change before a production release.

AuthenticationService

Customer Test Environment (Version 3):

https://secure.cte.tecapps.com/3/AuthenticationService.svc

https://secure.cte.tecapps.com/3/AuthenticationService.svc?wsdl

Production Environment (Version 3):

https://streaming.tecwsapps.com/3/AuthenticationService.svc

https://streaming.tecwsapps.com/3/AuthenticationService.svc?wsdl

OrderService

Customer Test Environment (Version 3):

https://secure.cte.tecapps.com/3/OrderService.svc

https://secure.cte.tecapps.com/3/OrderService.svc?wsdl

Production Environment (Version 3):

https://streaming.tecwsapps.com/3/OrderService.svc

https://streaming.tecwsapps.com/3/OrderService.svc?wsdl

PAFService

Customer Test Environment (Version 3):

https://secure.cte.tecapps.com/3/PAFService.svc

https://secure.cte.tecapps.com/3/PAFService.svc?wsdl

Production Environment (Version 3):

https://streaming.tecwsapps.com/3/PAFService.svc

https://streaming.tecwsapps.com/3/PAFService.svc?wsdl

AccountService

Customer Test Environment (Version 3):

https://secure.cte.tecapps.com/3/AccountService.svc

https://secure.cte.tecapps.com/3/AccountService.svc?wsdl

Production Environment (Version 3):

https://streaming.tecwsapps.com/3/AccountService.svc

https://streaming.tecwsapps.com/3/AccountService.svc?wsdl


AdminService

Customer Test Environment (Version 3):

https://secure.cte.tecapps.com/3/AdminService.svc

https://secure.cte.tecapps.com/3/AdminService.svc?wsdl

Production Environment (Version 3):

https://streaming.tecwsapps.com/3/AdminService.svc

https://streaming.tecwsapps.com/3/AdminService.svc?wsdl

PaymentProfileService

Production Environment:

https://www.tecsecurepay.com/PaymentProfileService.svc

https://www.tecsecurepay.com/PaymentProfileService.svc?wsdl


Sources
Name  Description 
AuthenticationService  The Service used to Authenticate all users
OrderService  The OrderService is the main service for processing address data.
AdminService  Interface for the AdminService. 
AccountService  Interface for the AccountService. 
PAFService  Interface for the PAFService. 
PaymentProfileService  Interface for the PaymentProfileService.