The terms of use gather all the rules to follow to use the API.

Your API key and the checksum salts must remain confidential as they represent your private parameters. Sharing them with third parties is strictly prohibited. Failure to adhere to this rule may result in deactivation of your API key for security reasons.

It is strongly recommended to use cache if you are using the API to display your rating and reviews on your site. This will ensure that the display of your page does not depend on the API responses and therefore does not affect its display time.

On your website:

You must prominently display the source of the reviews, Immodvisor, by including the Immodvisor logo or trust label on the page displaying the reviews with a link in the href that is crawlable by search engines and points to Immodvisor's company page. This is crucial for search engines to make the connection between the two pages and avoid duplicate content. Your review pages must be approved by our partnership department before being made live. You should also include a textual reference indicating that the reviews are sourced from the Immodvisor site.

Our partnership manager can be reached at 06 64 97 97 45 or by email at laurene@immodvisor.com

On other communication supports:

You must always display the Immodvisor logo and indicate that the reviews are from the Immodvisor solution.

In requests, the order of fields is crucial for successful processing. Ensure that fields are sent in the exact sequence specified in the documentation; any deviation in order may result in errors. Please follow the defined field structure precisely to avoid issues.

A checksum must be included with each API call. It is calculated by concatenating the following values in SHA1 format :

• apikey
• values of parameters sent in the order specified in the doc, formatted in JSON for arrays and objects.
• checksum_salt_in

PHP code example

private function calcChecksumIn($api_key, $checksum_salt_in, $datas = array())
    {
        $checksum = "";
        $checksum .= $api_key;
        foreach ($datas as $k => $v) {
            if ($v instanceof File) {
                $file = $v->getFilename();
                $file .= $v->getMimeType();
                $file .= $v->getSize();
                $v = $file;
            } elseif (is_array($v) || is_object($v)) {
                $v = json_encode($v, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
            } elseif ($v === true) {
                $v = 1;
            } elseif ($v === false) {
                $v = 0;
            }
            $checksum .= $v;
        }
        $checksum .= $checksum_salt_in;
        return sha1($checksum);
    }

Company's informations

Professional Account Management

A professional account must be linked to at least one of the companies associated with the partner.

If a professional account is associated with a brand, it will be automatically considered as linked to all the subsidiary companies under the brand's management. If it is associated with a subsidiary company, it will be considered as redundant, but is still allowed.

Review Management

Retrieving reviews and automating review collection

A review solicitation is the fact a customer reveived a communication asking for reviewing your company.

Custom questionnaires are defined company and can replace the default questionnaire used by customers for filing their review.

Endpoint utilities