Internal info : This call uses a 12 months average for shops that are listed in “shopsWithMovingAverageHack” in ekomi_settings table and returns the all-time average for shops which are not. As of v3, it no longer returns hotel-specific data (fb_avg_room, rating_room etc.) 

PRE-CONDITION

Parameter

Description

Example

mandatory

auth

Interface-ID and Interface-Password, separated by pipe (|)

665|FMJuyuC8uEbo3WxRa5aG

required

interface_id

Can be used together with interface_pw instead of auth

665

optional

interface_pw

Can be used together with interface_id instead of auth

FMJuyuC8uEbo3WxRa5aG

optional

version

Script-Version. For self-build. Precede with ‘cust-’

cust-1.0.0

required

type

Output type. Either “csv” (default) or “json”

csv

optional

charset

Character encoding. Either “iso” (default) or “utf-8” . For non-ISO languages (Russian, Chinese, etc.) and for all JSON utf-8 must be used.

iso

optional

other_params

Internal use only (do not release this to customers!)

a serialized string of array(‘fb_count’ => 23) where 23 is the number (>=10, <= 100) by which the number of results gets limited

default is 10.

a:1:{s:8:"fb_count";i:45;}

optional

POST-CONDITION

Parameter

Description

info

Contains a sub array with following values

Key

Description

account_name

company name (as identified at eKomi)

ekomi_certificateCertificate URL short. Example: https://www.ekomi.de/cert/4090571468444361ekomi_certificate_idNumber of eKomi Certificate. (also the dynamic part of the eKomi javascript widget code) Example: 4090571468444361ekomi_certificate_seo

SEO-optimized Certificate URL

Example: https://www.ekomi.de/bewertungen-ekomi-test.html

fb_count

Feedback count (number of reviews)

fb_avg

Feedback Average (Average of ratings) accurate to one decimal place

fb_avg_detail

Feedback Average (Average of ratings) accurate to four decimal places

activeReturn account status according to phase i.e true or false. The status would be true for phase 1, 2, 3, 4 and false for phase 5.

feedbacks

Contains an array which in turn contains 10 review arrays formatted as follows:

Key

Description

transaction_id

Order id for that review

rating

Number of given stars

message

Rating text

comment

Comments

delivered

Date of rating

Example: 2014-01-21 10:55:44

done

Will be 1 if request succeeds

done_at

Value contains a UNIX timestamp from the moment when the request succeeds

ERRORS

CODE

Name

Description

NonAuth

Missing authorization parameter

NonFunction

Invalid function name (for example ‘ptOrder’ instead of ‘putOrder’)

NonVersion

Missing version parameter

Access denied

Invalid authorization value