Last Update: 2022-10-11
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).
Send a XML as POST-parameter via HTTP-Request.
You can specify the customer for each request within the root-element
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>
||4-digits||Success- or Error-Code|
||varchar(255)||description of the returned code|
||string or xml||Optional; Depending on the request a single value or a xml-structure is returned|
||Optional; Some requests return big results which will be splitted in pages|
||Number of current page|
||Number of records per page|
||Number of previous page (empty if there's no previous page)|
||Number of next page (empty if there's no next page)|
||Number of last page|
||int(10)||Total number of all records|
|3002||Error: Access from this IP denied|
|3004||Error: Request-XML missing|
|3005||Error: Username and/or password wrong|
|3006||Error: Command needs authentification|
|3007||Error: Cannot parse XML|
|3008||Error: Unknown request|
|3009||Error: Command is not available any more|
|3010||Error: Command needs admin privileges|
|3011||Error: Paramater missing|
|3012||Error: Paramater invalid|