Skip to content
  • Documentation >
  • Apps >
  • Commerce >
  • Mallabe Websites

Mallabe Websites

The Mallabe Websites modules allow you to monitor and retrieve the visitors, website status, and website thumbnails in your Mallabe Websites account.

Getting Started with Mallabe Websites

Prerequisites

Connecting Mallabe Websites to Ibexa Connect

To connect your Mallabe Websites account to Ibexa Connect you need to obtain the API Key from your Mallabe Website account and insert it in the Create a connection dialog in the Ibexa Connect module.

1. Log in to your Mallabe Websites account.

2. From the Home screen, click API Keys and copy the API key to your clipboard.

61d6a5403016d.png

3. Go to Ibexa Connect and open the Mallabe Websites module's Create a connection dialog.

61d6a541ad81c.gif

4. In the Connection name field, enter a name for the connection.

5. In the API Key field, enter the API key copied in step 2, and click Continue.

The connection has been established.

Thumbnails

Watch Website Thumbnails

Triggers when a website thumbnail has been generated.

Get a Website Thumbnail

Gets a website thumbnail.
Website URL Enter (map) the website URL address whose thumbnail details you want to retrieve. For example, www.google.com.
Webhook URL Enter (map) the webhook URL address to send the triggers with the required data.

Status

Watch Website Status

Triggers when a website status check has been executed.

Check Website Status

Checks the status of a website.
Website URL Enter (map) the URL address whose status you want to check.
Method By default, it is the GET method to retrieve the status of the website.
Webhook URL Enter (map) the webhook URL address to which you want to send the data of the operation.

Other

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.mallabe.com/v1/websites For example: /thumbnail

For the list of available endpoints, refer to the Mallabe Website API Documentation.

Method

Select the HTTP method you want to use:

  • GET - to retrieve information for an entry.

  • POST - to create a new entry.

  • PUT - to update/replace an existing entry.

  • PATCH - to make a partial entry update.

  • DELETE - to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Website Status

The following API call returns the website status from your Mallbe Websites account:

URL:

/status

Method:

GET

61d6a54433644.png

Matches of the search can be found in the module's Output under Bundle > Body.

In our example, the specified website status details were returned:

msedge_uhchn1i2v5.png