Allianz Global Assistance Insurance API - Overview

The Insurance API consists of a set of REST-style webservice endpoints. Whenever possible, it is recommended that navigation from one API call to the next be driven by the urls given in the API response, rather than programming a static reference to a particular API url. For example, the Category Lookup API provides a url to the Category API, which in turn provides urls to the Product API for a set of products. By following this sequence of urls as provided by the API responses, a consumer of the Insurance API is unaffected by any changes to the url format or the codes that are in use. The exceptions to this convention are the Category Lookup API (since it is the entry point to the Category and Product APIs); and the Offer and Policy APIs, which do not represent resource locations, but rather invokable operations.

All webservice APIs share the following features:

Content Negotiation

The service supports content negotiation so that either XML- or JSON-formatted messages can be used for requests and responses. The request format should be identified using the http Content-Type header, using any of the following supported values: "application/xml", "text/xml", or "application/json". The desired response format is specified using the http Accept header, which supports these same values. The default if neither is specified is “application/json”. The examples in this document are provided in json.

Language Support

The language to be used for response messages can be specified in two ways. Every api’s url can optionally contain a language parameter immediately following the domain. For example:

https://api.allianz-assistance.ca/Offer (no language specified)
https://api.allianz-assistance.ca/en/Offer (English specified)

The language is specified using ISO 639-1 2-digit alpha code, with an optional culture variant (ex: "fr" is French with no language variant specified, "fr-FR" is French with France culture variant, "fr-CA" is French, with Canada culture variant). Languages currently supported are "en" and "fr", or any culture-specific variant thereof.

The language may also be specified using the http "Accept-Language" header. The same values are supported via this header as are supported in the url parameter. If both are specified, the url parameter takes precedence; and if neither is specified, the default is English.