API documentation → Import

Check if imported website is owned by user available since version 4.0.0 / 3.7.312 On-Premises

Important:
This is a description of API endpoint that builder expects to exist when imported website ownership verification is enabled and set to use this API.

For builder to use this API it must be enabled and URL of API endpoint for this request (Call API URL) must be entered in the builder configuration. To do this you must:

open brand properties dialog,
open builder customization dialog ("Customize Builder" link),
switch to configuration tab,
make sure "Check website ownership" is checked,
enter URL of your API endpoint in "Custom ownership checking API endpoint URL" field,
apply changes.

Call API URL: http://your-domain.com/check-ownership.php
Method: POST
Content Type: application/json
Expected Returned Content Type: application/json

JSON request Object Properties:

String key - integration API secret key that is entered in brand configuration (since v3.7.314).
String domain - domain that must be checked if it is owned by the user.
String id_domain - domain that is currently open in website builder.
String id_ip - IP (for external publish type) or URL (for internal publish type) where current website is set to be published. See apiUrl property of "Create session" API request.
String id_ext_reference_id - (optional) Copy of extReferenceId property passed to website builder with "Create session" API request. Available only when custom API is used to open website builder.

JSON response Object Properties:

Boolean ok - value must be set to true when requested domain is owned by the user and website may be imported;

Example

Request sent from builder to your verification endpoint:

POST /check-ownership.php HTTP/1.1
Host: your-domain.com
Content-Type: application/json

{
    "key": "",
    "domain": "example.com",
    "id_domain": "my-new-website.com",
    "id_ip": "192.66.66.1"
}

Response when user owns example.com and it may be imported:

HTTP/1.1 200 OK
Content-Type: application/json

{
   "ok": true
}

Response when unable to confirm that user owns example.com:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "ok": false
}