Introduction

The following is a guideline to the standard eyepin interface. This interface gives you the opportunity to handle data in booth directions - import and export data records from your CMS/CRM to eyepin and vice versa.

It's reasonable that most customers prefer to use their own CMS/CRM to track their company related content (e.g. addresses, articles).

The data transfer takes place via XML-Records (Extended Markup Language). Depending on what you intend to do, there are special commands for altering (edit, remove, add) data records, which will be explained in this document later.

The idea is very simple, a URL is called which pass the data/request to eyepin and you get a response back (Response XML).

Further more there are so called event-handlers, which can perform actions (e.g. calling a url with passing data) when something happens to the eyepin user database (e.g. someone changing his personal information).

Request

Send a XML as POST-parameter via HTTP-Request.

• The XML specifies the API-Command and it's parameters or data.
• The name of the POST-parameter does not matter, the first POST-parameter is always taken.
• The name of the XML root-element specifies the API-Command.

URL

https://apiv3.eyepin.com/interface3.php

Security

• Login via basic-authentication
• The username and password used in the interface authentication is different from your normal eyepin username and password.

Specify customer (only with suite-manager access-data)

You can specify the customer for each request within the root-element
e.g.: <addressinsert customerid="">...</addressinsert>

Example Request

A simple example in PHP and the cURL extension that shows how to subscribe a contact.

$url = 'https://apiv3.eyepin.com/interface3.php';
$username = 'USERNAME';
$password = 'PASSWORD';

$request = '<?xml version="1.0" encoding="utf-8"?>
  <addressinsert>
    <email><![CDATA[max.mustermann@eyepin.com]]></email>
    <salutation>male</salutation>
    <firstname><![CDATA[Max]]></firstname>
    <lastname><![CDATA[Mustermann]]></lastname>
    <status>1</status>
  </addressinsert>
';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_USERPWD, $username . ':' . $password);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$response = curl_exec($ch);
$ErrNum = curl_errno($ch);
$ErrMsg = curl_error($ch);
curl_close($ch);

if ($ErrNum != 0) {
  die('Error cURL: ' . $ErrMsg);
}

$xml = simplexml_load_string($response, null, LIBXML_NOCDATA);
if (!$xml) {
  die('Error: Cannot parse response-XML');
}

if ((string)$xml->code !== '2000') {
  die((string)$xml->description);
}

echo 'Success! Contact with id=' . (string)$xml->data . ' created.';

Response

Each request returns a XML in the following form:

<?xml version="1.0" encoding="utf-8"?>
<response>
  <code></code>
  <description></description>
  <data></data>
  <paging>
    <page></page>
    <pagesize></pagesize>
    <prev></prev>
    <next></next>
    <last></last>
    <numrecords></numrecords>
  </paging>
</response>

Common Response-Codes