Web Service API Setup

The AMS360 Web Service Application Programming Interface (WSAPI) allows authorized users to perform various operations on AMS360 data. A user name and a password are required to access the Web Service API, which will then allow third-party applications to send, receive and/or update data directly within your AMS360 database, while still preserving data integrity and AMS360 security.

  1. Open the Administration Center.
  2. On the General menu, select Web Service API.

This is the area where you grant users (i.e., vendors / developers) 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. This list contains specific integration solutions we have to helped develop (i.e. BenefitPoint, ImageRight, & 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 six characters in length
  • Maximum length allowed is 30 characters
  • Passwords are case-sensitive
  • Must be alphanumeric 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. These 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 20 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.

This field grants Web Service Application rights to Customers/Policies that 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.

This field grants Web Service Application rights to Customers/Policies that 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.

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 any options not available for an entity.
Question Answer

How might Web Services be useful?

Many integrated solutions have built integrations that use Web Services APIs through AMS360, which can provide you with complimentary solutions to your AMS360 system to be able to put in, take out, update, or delete information within your system' this allows you to not have to re-key information in multiple systems.

There are also other forms of APIs that AMS360 offers, which includes EMS and OData. These allow you or your vendor to gain access to additional endpoints that may not be available through Web Services APIs.

Who needs the Web Service SDK?

 Agencies and/or third party vendors who plan to write a program using the Web Service API.

Who can access the Web Service?

Your agency can authorize vendor access to your database via a new Web Service API Setup.  Your agency can secure access to data by setting up security authorization for the web service authentication, just as is done now with employees.

How do I get it on my system?

 The Web Service API setup dialog box is included with AMS360.

Is there a cost for 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 (i.e. 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 ensure the request will maintain the integrity of your data.

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

If you require technical assistance, you can reach out to our support team directly, submit a support ticket through MyVertafore, or work directly with the vendor with whom you are integrating, since they can support you with a configuration guide.

What can I do with Web Service API?

Web Service API supports the retrieving, inserting, updating and deleting of data within AMS360. You can refer to the following table that summarizes the types of operations that WSAPI supports for each of its entities here.

Related Topics Link IconRelated Topics