Overview

The AdBookConnect API provides capabilities for integrating client applications with the AdBook system, using standard SOAP 1.2 web services.  Functionality provided includes the ability to retrieve all data required for creating or updating orders in AdBook, as well as executing the actual create/update operations.

This documentation is intended for technical personnel who are developing client systems that need to extract and submit AdBook data.

Security

Rquests to the AdBookConnect web service are authenticated using WS-Security header information as described in the W3C WS-Security specification.  AdBookConect login IDs and passwords are the same as the login ID and password used for AdBook UI login.  However, API permission must be granted for any login ID used for accessing AdBookConnect.  Please contact your AdBook customer service representative to have this permission turned on for the desired AdBook login ID.

Connectivity

The url used to connect to the web service will vary depending on which AdBook instance is used by your organization.  There are three instances of AdBook available:

- adbook01.fattail.com

- adbook02.fattail.com

- adbook03.fattail.com

For each instance, there are two endpoints available for connecting with AdBookConnect, depending on what level of security is required by the client application.  When binding to AdBookConnect using transport level security, use:

http://adbookinstance/abn/ws/AdBookConnect.svc

where adbookinstance is one of the urls listed above.

Structure

All operations in the AdBookConnect API are based on AdBook data element ID values.  As such, the client process must obtain AdBook data element ID information before submitting requests for create, update, etc.  To facilitate the ID lookup operations, methods are provided to retrieve lists of the data elements required to support order entry and update operations.  For example, a typical sequence of steps to accomplish a successful order creation operation using AdBookConnect would be as follows:

·         Make calls to collect list data for all data elements required to create an order

·         Lookup the appropriate ID values based on data available in the client system, using the list data

·         Assign order properties, including ID values from the lookup operations

·         Assign user credential information

·         Call the AdBookConnect.CreateOrder method

 

Versioning

Version specifications are used in the AdBookConnect API to allow backward compatability when new properties are added to classes.  Client processes that access properties that were added after the initial launch of the AdBookConnect API need to specify a Version element in the header with a value that is at or above the API version where the new property was implemented.  In addition, the version must be valid at the time the WSDL is consumed.  See Appendix A for information on what properties are available in which versions.