Web Service API Setup

Use this feature to set up a Web Service API user name, password and assign permissions. This user name and password are used to access the Web Service API allowing for third-party applications to send, receive, and/or update data directly within your AMS360 database, while still preserving data integrity and AMS360 security.

Producer Plus uses Web Service API for integration of Activity and Suspense items. See the Related Topics button below for access to an overview of the integration.

ClosedAccessing Web Service API Setup
  1. Open the Administration Center.
  2. On the General menu, select Web Service API.
ClosedWeb Service Application Authorization Section

This is where you grant user (developer) access rights to a entities in your AMS360 database.

Field What is this?

Web Service Application

You have the option to select from the list a pre-defined set of entities and associated actions. The list contains specific integration solutions we have helped develop (i.e. BenefitPoint Integration, TransactNow Integration),

or

Use the Custom option to grant access for entities and their specific associated actions for your end-user/developer to access.

WSAPI Login ID
  • Required field
  • See Data Security Based on: for more options.

Password
  • Required field
  • Must be a least 6 characters in length
  • Maximum length allowed is 30 characters
  • Passwords are case sensitive
  • Must be alpha numeric characters only
  • Must include at least one numeric character
  • Must include at least one upper case character
  • Must include at least one lower case character

Verify Password

Entry must match Password field

Reapply Defaults

Used for a new version of a Web Service. Click Reapply Defaults to plug the default entity access items to the grid for the Web Service. The defaults come from within the new version of the service.

Reset Login

After five failed attempts, a user is locked out from any further attempts at login for a period of twenty minutes. This lockout can be overridden by selecting Reset Login for the affected user.

Data Security Based on
Field What is this?

Specific Employee

Select to choose an AMS360 employee from the drop down list.

Grants Web Service Application rights to Customers/Policies which meet this employee’s Business Unit Security and login time access.

Secured Customers are excluded from the web service.

Employee Supplied by Web Service

Select to use if your Web Service programmer will supply the AMS360 employee at runtime.

Grants Web Service Application rights to Customers/Policies which meet this employee’s Business Unit Security access  

Secured Customers are excluded from the web service.

Entity Access Security Only

Select if no employee's security is desired at runtime for the WSAPI Login ID.

No business unit security is enforced. Secured Customers are available.
ClosedEntity Access

The Web Service API includes entities with database access capabilities. These capabilities vary by entity and include retrieve, add, update, and delete actions. The currently available entities are listed in this section. Use Check All and Uncheck All to quickly add or remove access for entities.

 

Check boxes do not appear for the options not available for an entity.
ClosedFrequently Asked Questions
Question Answer

How might Web Services be useful?

When you wish to perform specialized operations on the data in your database, the Web Service API provides the means by which you can accomplish this. In some cases, the operation may be as simple as retrieving data to send to a bulk mailer. In other cases it could be more complicated like automatically importing leads gathered through your agency web site. Web Services also provides access to your data which may be used for enhanced reporting or data analysis outside of what is offered through AMS360.

Who needs the Web Service SDK?

Agencies and/or third party vendors who plan to write a program using the Web Service API, must purchase the Web Service SDK from Vertafore Sales.

 

If your agency acquires an existing program written using the Web Services SDK purchased from Vertafore Sales, you only need to set up a user name and password to use the program. There are no additional fees. The Web Services SDK is only required to code the program, not to use it.

Who can access the Web Service?

Once the Web Service SDK is purchased, your agency can authorize vendor access to your database through a new Web Service API Setup form that’s part of your AMS360 system.  our agency can secure access to data by setting up security authorization for the web service authentication just as you do employees now.

 

If your agency acquires an existing program written using the Web Services SDK purchased from Vertafore Sales, you only need to set up a user name and password to use the program. There are no additional fees. The Web Services SDK is only required to code the program, not to use it.

How do I get it on my system?

The Web Service API setup dialog box is included with AMS360, however you will need to contact Vertafore and ask for a Web Service SDK agreement. Once that agreement is signed by both you and Vertafore, the Web Service API SDK is enabled for your agency’s My Vertafore login.

 

If your agency acquires an existing program written using the Web Services SDK purchased from Vertafore Sales, you only need to set up a user name and password to use the program. There are no additional fees. The Web Services SDK is only required to code the program, not to use it.

Why do I need an extra agreement?

The Web Service SDK is a separately licensed product.

What is included in the SDK?

The SDK is an online developer’s package that includes the following components:

  • Description of the web service methodology used.
  • WSDL, Web Service Description Language describing our web service.
  • Authentication discussion.
  • Description of all Web Methods available and the data contracts associated with those methods.
  • Sample programs.
  • In-house agencies also receive an installation package with instructions on how to download the programs to your server.

Is there a cost to access the Web Service API?

The Web Service API is provided at no additional charge.

How does it work?

Each method of the Web Service API provides some specific operation (for example, retrieve, insert, and update) to be performed on your database. This gives direct access to your data bypassing the standard processing performed by AMS360. Even though the standard processing of AMS360 is bypassed, all requests are validated to insure the request will maintain the integrity of your data.

Besides the documentation, is there any other help I can get?

If you need technical assistance beyond the SDK, you can contact the Vertafore Professional Services Custom Group to set up a consulting agreement where we can provide additional assistance. This is s billable service that usually takes 5 to 10 hours.  

What can I do with Web Service API?

The first release of Web Service API supports retrieving, inserting and updating data for customers as well as limited policy information. Retrieval list of supporting data such as employees, business units and companies is also available. Future releases will expand the list of available operations. The future course of the Web Service API will be greatly influenced by the requests and needs of our agents.

Is there a way to test our programs?

We are making available a test environment which can be used for testing web service on sample data.

 

There will be an additional charge for this service. Parameters, costs and agreements can be obtained by contacting Vertafore.

Related Topics Link IconRelated Topics

 

© 2024 Vertafore