Get Started with Examinare Survey Tool API

Video Tutorial on How to Activate Examinare API

Red fields are required and must have a value. XML-data is sent using HTTPS as POST-data.
In the beginning of this document there is a summary of the available functions. This is followed by a more detailed part.

URL for all functions are
https://api.examinare.com/framework
To connect you need to add three commands to the POST data:

apiKey – This is provided by Examinare in your account.
apiCompany – The company database to be used.
Command – The command you provide for the call.
Please note: More commands may be needed by the function you call.

Mobile API and non-shared API keys.

If you for any reason want to keep your API key private and use a Login type of Style instead of the Static Examinare API key then you may use the Mobile API command setPhoneID, this command can be used to get a Mobile API token that can be used instead of the static API token.  All mobile API tokens can be deleted at any time from your Examinare account inside the Settings -> Advanced Settings.

<?php class ExaminareAPIConnector{ public $credentials; public $command; public $sendinfo; public $returnjson=0; public function __construct ($apiuser,$apikey,$apiurl){ if($apiurl==""){$apiurl="api.examinare.com";} $url="https://".$apiurl."/framework"; $companyid=$apiuser; $token=$apikey; $this->sendinfo['apiKey']=$token; $this->sendinfo['apiCompany']=$companyid; $this->sendinfo['url']=$url; } public function setCommand($Command){ $this->sendinfo['Command']=$Command; } public function Data($sendinfo){ foreach ($sendinfo as $key => $value) {$this->sendinfo[$key]=$value;} } public function JsonEnable(){ $this->returnjson=1; } public function Execute(){ $sendinfo=$this->sendinfo; $method = "POST"; $action=$this->sendinfo['url']; $fields=""; foreach ($sendinfo as $key => $value) { if ($key != 'url') { $fields .= $key . '=' . rawurlencode($value) . '&'; } } $fields = substr($fields, 0, strlen($fields) - 1); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $action); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $fields); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $result = curl_exec($ch); $info_arrays = curl_getinfo($ch); curl_close($ch); if($result === false ){ return false; }else{ if($this->returnjson==1){ return json_decode($result,1); }else{ return $this->toArray(new SimpleXMLElement($result)); } } } public function ExecuteRaw(){ // Used to get the raw file from the url. $sendinfo=$this->sendinfo; $method = "POST"; $action=$this->sendinfo['url']; $fields=""; foreach ($sendinfo as $key => $value) { if ($key != 'url') { $fields .= $key . '=' . rawurlencode($value) . '&'; } } $fields = substr($fields, 0, strlen($fields) - 1); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $action); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $fields); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); $result = curl_exec($ch); $info_arrays = curl_getinfo($ch); curl_close($ch); if($result === false ){ return false; }else{ return $result; } } public function toArray($xml) { $array = json_decode(json_encode($xml), TRUE); foreach ( array_slice($array, 0) as $key => $value ) { if ( empty($value) ) $array[$key] = NULL; elseif ( is_array($value) ) $array[$key] = $this->toArray($value); } return $array; } } ?>

The PHP Wrapper Library Code.

No downloads OR long readme files.

Just copy and paste into where you want the code put.

If you choose the filename "examinare-api.php" then all PHP Code examples on this site will work with the urls.

Otherwise, you need to update your codes include statement on the top. Our Php-wrapper is now located at Github. https://github.com/examinare/examinare-php-wrapper

<?xml version="1.0" encoding="utf-8"?> <response> <status>Success</status> <tokens> <token>UMOBI:7182101920d9s9f7d8f6d76f7sd8sd98as</token> <cname>CNAME</cname> </tokens> </response>

With the setPhoneID you can create your own API keys that will be connected to a live administrative user in your Examinare account. You need to activate the Mobile Keys functions in your Configuration tab in your Examinare account.

POST data information:
(Red information is mandatory), all POST data captions are case-sensitive.