Introduction

The Envisage Global Insurance API is provided as a means of automating the basic administrative tasks for a EGI Plan Administrator.

To use the Envisage Global Insurance API, you must have a valid EGI user account and be issued an API key by your account representative.

This API is primarily a RESTful one, but does require POST authentication for all requests. For that reason, we recommend building your requests via CURL, and have provided examples on how to do so. All responses are returned as JSON objects with success and status codes, in addition to the requested data (See example).

Accepted POST Content types:

• application/x-www-form-urlencoded
• multipart/form-data
• application/json

Document Formatting Notes

Parameters

Parameter Key

https://www.envisageglobalinsurance.com/admin/api/ApiParticipant/findParticipant/id/4512 // OK!
https://www.envisageglobalinsurance.com/admin/api/ApiParticipant/findParticipant?id=4512 // OK!

https://www.envisageglobalinsurance.com/admin/api/ApiPlan/findUpdatedParticipants/id/83/since/2018/01/01  // OK!
https://www.envisageglobalinsurance.com/admin/api/ApiPlan/findUpdatedParticipants/id/83?year=2018&month=01&day=01  // OK!
https://www.envisageglobalinsurance.com/admin/api/ApiPlan/findUpdatedParticipants/id/83?since=2018/01/01  // NOT OK

Participant Status Keys

Authentication

To use the Envisage Global Insurance API, you must have a valid EGI user account and be issued an API key. If you have any problems with your API key, or need to be issued a new one, please contact your account representative.

For security reasons, all requests will require your user name and API key to be provided as key-value pairs via POST (See example).

Response Format (JSON)

All API responses will be returned as JSON in the following format with a statusCode, success indicator and a detailed response object which will vary per action.

	{
		statusCode:200,
		success:true,
		response:
			[{
				first_name:John,
				middle_name:Q,
				last_name:Public,
				dateOfBirth:1988-09-29,
				gender:M,
				address1:123 Main Street,
				address2:null,
				city:Large City,
				state:Florida,
				zip:32230,
				country:United States,
				homeCountry:Italy,
				email:name@address.com,
				phone:555-555-5555,
				plan_id:2,
				status_id:2,
				sports_rider:0,
				start_Date:2011-11-23,
				end_date:2011-12-31,
				labels:"test,test2"
			}]
	}

In all of the action-specific examples below, the JSON described will be found in the "response"portion of the above object.

Example PHP w/ CURL

	$ch = curl_init();
	curl_setopt($ch, CURLOPT_URL, "https://www.envisageglobalinsurance.com/admin/api/ApiParticipant/findParticipant/id/4512");
	curl_setopt($ch, CURLOPT_HEADER, 1);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');

	# Build the array of POST options - REQUIRES name and key
	$query = http_build_query(array(
		'user' => 'yourname@yourcompany.com',
		'key' => 'a0c3ku89v12d0mn35c',
	));

	curl_setopt($ch, CURLOPT_POSTFIELDS, $query);

	$data = curl_exec($ch);
	curl_close($ch);

	print_r($data);
	echo "\n";

Example PHP w/ CURL sending as JSON

	$data = [
		'user' => self::API_USER,
		'key'  => self::API_KEY,
	];

	$data_string = json_encode( $data );

	$ch = curl_init("https://www.envisageglobalinsurance.com/admin/api/ApiParticipant/findParticipant/id/4512");

	curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
	curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		'Content-Type: application/json',
		'Content-Length: ' . strlen( $data_string )
	]);
	curl_setopt($ch, CURLOPT_TIMEOUT, 5);
	curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);

	$result = curl_exec( $ch );

	curl_close($ch);

Status Codes

Change Log