Open API Usage
Some general information about the Vern Open API.
Basics
The Vern Open API is built on the REST framework, therefore expect to use both requests and responses in a JSON format.
Test environment
We are hosting a test environment on https://api.staging.vernhelps.com that provides the same funcionality as our production server, however the created insurance documents are not valid.
Production environment
The production environment will be available on https://api.vernhelps.com.
Glossary
Policyholder: the person who is creating and requesting the insurance form the insurance provider. Not always covered in the insurance policy.
Insured (customer) / traveller: real person, whom is covered by the insurance.
Quote parameters: initial parameters to request an insurance quote, e.g. the duration of the travel or the destination.
Quote: the response based on quote parameters. Usually contains a set of insurance packages with calculated prices.
Policy: the final form of the insurance. A legal document with insured people and the applied coverage.
Group policy: the policyholder of a group policy is predefined and travellers are insured under this policy over time.
Insurance provider: the insurance company, who will insure the customers in the end.
Product: insurance is sold in products, these are predefined configurations of coverages.
Addon: insurance products can be upgraded with addons to have extra coverage, such as car insurance.
Bundles: Vern creates customized grouping of products for different occasions, these are called bundles.
Language
Currently the API is available in English and Hungarian, this means that Vern is able to return textual contents translated into on of these languages. You can set the language by using header parameters in your request:
| Key | Value |
|---|---|
| X-Locale | en or hu |
Error handling
The API is ready to return an understandable error message for most of the errors. We try to validate every request as much as we can, but sometimes it could happen, that we return an error message thrown by a web service of an insurance provider. In these cases, the format of the error is defined by the insurance provider.