Searchanise

https://docs.searchanise.io
Admin
Searchanise is a smart search and filtering application for e-commerce platforms that provides...
Tokens:110,542
Snippets:1,935
Trust Score:8.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### Enable maintenance mode

Source: https://docs.searchanise.io/install-extension-magento-2

Run this command to enable maintenance mode before starting the installation process.

```bash
bin/magento maintenance:enable
```

--------------------------------

### Install extension via Composer

Source: https://docs.searchanise.io/install-extension-magento-2

Command to install the extension using the Composer package manager.

```bash
composer require searchanise/search-autocomplete
```

--------------------------------

### Verify extension installation

Source: https://docs.searchanise.io/install-extension-magento-2

Commands to check the status of the module and enable it if necessary.

```bash
bin/magento module:status
```

```bash
bin/magento module:enable Searchanise_SearchAutocomplete --clear-static-content
```

--------------------------------

### Remove Searchanise setup record

Source: https://docs.searchanise.io/reinstall-from-scratch-magento1

Execute this SQL query to remove the extension's setup record from the core_resource table during the reinstallation process.

```sql
DELETE FROM core_resource WHERE core_resource.`code` = ‘searchanise_setup’
```

--------------------------------

### Phrase matching search examples

Source: https://docs.searchanise.io/search-precision-settings

Examples of search queries used to demonstrate OR logic versus AND logic in phrase matching.

```text
Football boots
```

```text
Football boots
```

--------------------------------

### Navigate to Magento extension directory

Source: https://docs.searchanise.io/fatal-error-class-not-found

Use this command to enter the community code directory where the extension is installed.

```bash
cd app/code/community/
```

--------------------------------

### Partial word matching example

Source: https://docs.searchanise.io/search-precision-settings

Demonstrates the default behavior where search matches parts of words.

```text
sh
```

--------------------------------

### Handle Registration Errors

Source: https://docs.searchanise.io/signup-api

Example of a response received when a registration request fails due to invalid parameters.

```bash
curl -X POST "http://searchserverapi1.com/api/signup/json"
 > {"errors":{"error":"Invalid email or url"}}
```

--------------------------------

### Perform a Search API Request

Source: https://docs.searchanise.io/search-api

Example of a GET request to the Searchanise API with facets, categories, and pages enabled, returning a JSON response.

```bash
curl -X GET "http://searchserverapi1.com/getwidgets?apiKey=XXXXXXXXXX&q=test&facets=true&categories=true&pages=true&output=json"
 > {"totalItems":2,"startIndex":0,"itemsPerPage":10,"currentItemCount":2,"categoryStartIndex":0,"totalCategories":1,"pageStartIndex":0,"totalPages":1,"categories":[{"category_id":"1","title":"Category1 title","link":"https:\/\/example.com\/categories\/category1","image_link":"https:\/\/example.com\/images\/category1.jpg"}],"pages":[{"page_id":"1","title":"Page1 title","link":"https:\/\/example.com\/pages\/page1","image_link":"https:\/\/example.com\/images\/page1.jpg"}],"items":[{"product_id":"1","title":"Test product 1","description":"Test description","link":"https:\/\/example.com\/products\/product1","price":"12.0000","list_price":"0.0000","quantity":"","product_code":"product1","image_link":"https:\/\/example.com\/images\/product1.jpg"},{"product_id":"2","title":"Test product 2","description":"Test summary","link":"https:\/\/example.com\/products\/product2","price":"168.0000","list_price":"0.0000","quantity":"","product_code":"product2","image_link":"https:\/\/example.com\/images\/product2.jpg"}],"facets":[{"title":"Price","attribute":"price","type":"range","buckets":[{"value":"0.0000,150.0000","title":"from 0 to 150","from":"0.0000","to":"150.0000","count":"1"},{"value":"150.0000,800.0000","title":"from 150 to 800","from":"150.0000","to":"800.0000","count":"1"}]},{"title":"Categories","attribute":"categories","type":"select","appearance":"default","more_count":"0","buckets":[{"value":"Category1","count":1},{"value":"Category2","count":1}]}]}
```

--------------------------------

### Create auth.json file

Source: https://docs.searchanise.io/install-extension-magento-2

Command to create the auth.json file from the sample file.

```bash
cp auth.json.sample auth.json
```

--------------------------------

### Initialize Searchanise Widgets

Source: https://docs.searchanise.io/widgets-js-api

Use this script to connect the Searchanise service and configure widget parameters. Ensure the API key and jQuery selectors are correctly defined for your environment.

```html
<script type="text/javascript">
    Searchanise = {};
    Searchanise.host = 'https://searchserverapi1.com';
    Searchanise.ApiKey = 'XXXXXXXXXX';
    Searchanise.SearchInput = '#search_input';

    Searchanise.AutoCmpParams = {};
    Searchanise.AutoCmpParams.restrictBy = {};
    Searchanise.AutoCmpParams.restrictBy.status = 'A';

    Searchanise.ResultsParams = {};
    Searchanise.ResultsParams.restrictBy = {};
    Searchanise.ResultsParams.restrictBy.status = 'A';

    Searchanise.options = {};
    Searchanise.options.ResultsDiv = '#snize_results';
    Searchanise.options.PriceFormat = {
        rate : 1.0,
        symbol: '$',
        decimals: 2,
        decimals_separator: '.',
        thousands_separator: ',', 
        after: false
    };

    (function() {
        var __se = document.createElement('script');
        __se.src = 'https://www.searchanise.com/widgets/v1.0/init.js';
        __se.setAttribute('async', 'true');
        var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(__se, s);
    })();
</script>
<input type="text" id="search_input" name="q" value="">
<div id="snize_results"><div>
```

--------------------------------

### JavaScript for Smart Navigation Initialization

Source: https://docs.searchanise.io/set-up-smart-navigation-brand-bigcommerce

Handles the dynamic loading and column configuration of the search results grid based on container width.

```javascript
(function(window, undefined) {
    /* Themes hack */
    var pageContent = document.querySelector('.page:not(.content-page-with-sidenav) > .page-content');
    var pageSidebar = document.querySelector('.page > .page-sidebar');

    if (pageContent && !pageSidebar) {
        pageContent.style.width = '100%';
    }

    var snize_results = document.getElementById('snize_results');
    if (snize_results != null && snize_results != undefined && snize_results.innerHTML != '') {
        return;
    }
    sInterval = setInterval(function() {
        var snize_results = document.getElementById('snize_results');
        if (snize_results && snize_results.innerHTML != '') {
            clearInterval(sInterval);
            var skeleton_results = document.getElementById('snize_skeleton_results');
            if (skeleton_results && skeleton_results.innerHTML != '') {
                skeleton_results.parentNode.removeChild(skeleton_results);
            }
            return;
        }
        var grid_wrapper = document.getElementById('snize-search-results-wrapper');
        if (grid_wrapper) {
            if (grid_wrapper.offsetWidth >= 1055) {
                grid_wrapper.className = grid_wrapper.className.replace(/(?:^|\s)snize-three-columns(?!\S)/g , '').replace(/(?:^|\s)snize-four-columns(?!\S)/g , '');
                if (!grid_wrapper.className.match(/(?:^|\s)snize-five-columns(?!\S)/)) {
                    grid_wrapper.className += ' snize-five-columns';
                }
            } else if (grid_wrapper.offsetWidth >= 915) {
                grid_wrapper.className = grid_wrapper.className.replace(/(?:^|\s)snize-three-columns(?!\S)/g , '').replace(/(?:^|\s)snize-five-columns(?!\S)/g , '');
                if (!grid_wrapper.className.match(/(?:^|\s)snize-four-columns(?!\S)/)) {
                    grid_wrapper.className += ' snize-four-columns';
                }
            } else {
                grid_wrapper.className = grid_wrapper.className.replace(/(?:^|\s)snize-four-columns(?!\S)/g , '').replace(/(?:^|\s)snize-five-columns(?!\S)/g , '');
                if (!grid_wrapper.className.match(/(?:^|\s)snize-three-columns(?!\S)/)) {
                    grid_wrapper.className += ' snize-three-columns';
                }
            }
        }
    }, 30);
})(window);
```

--------------------------------

### GET https://searchserverapi1.com/api/state/get/json

Source: https://docs.searchanise.io/update-api

Retrieves the current status of the Searchanise account.

```APIDOC
## GET https://searchserverapi1.com/api/state/get/json

### Description
Retrieves the status of the account, including import progress and current state.

### Method
GET

### Endpoint
https://searchserverapi1.com/api/state/get/json

### Parameters
#### Query Parameters
- **private_key** (string) - Required - Private key
- **status** (string) - Optional - Request status
- **full_import** (string) - Optional - Request full import status
- **product_count** (string) - Optional - Request product count

### Request Example
curl -X GET "https://searchserverapi1.com/api/state/get/json?private_key=XXXXXXXXXXXXXXXXXXXX&status&full_import&product_count"
```

--------------------------------

### GET /search

Source: https://docs.searchanise.io/search-api

Retrieves search results returning only IDs for products, categories, and pages.

```APIDOC
## GET https://searchserverapi1.com/search

### Description
Retrieves search results returning only IDs for the found products, categories, and pages.

### Method
GET

### Endpoint
https://searchserverapi1.com/search

### Parameters
#### Query Parameters
- **apiKey** (string) - Required - Public API key
- **output** (string) - Optional - Response format (json, jsonp, print). Default: json
- **q** (string) - Optional - Search by string (by all attributes)
- **maxResults** (int) - Optional - The number of products in the results (0..250). Default: 10
```

--------------------------------

### Execute cron command for indexation

Source: https://docs.searchanise.io/indexation-cron-cs-cart

Use this command to initiate the Searchanise indexation. Replace %PATH_TO_CS_CART_ROOT_DIR% and %COMPANY_ID% with your specific environment details.

```bash
/usr/bin/php %PATH_TO_CS_CART_ROOT_DIR%/index.php --dispatch=searchanise.async --full_reimport=Y --ignore_processing=Y --switch_company_id=%COMPANY_ID%
```

--------------------------------

### POST http://searchserverapi1.com/api/signup/json

Source: https://docs.searchanise.io/signup-api

Registers a store to obtain API keys. For multi-language stores, repeat this process and provide the parent_private_key from the initial registration.

```APIDOC
## POST http://searchserverapi1.com/api/signup/json

### Description
Registers a new store engine to receive public and private API keys. This process is required for each language version of a store.

### Method
POST

### Endpoint
http://searchserverapi1.com/api/signup/json

### Parameters
#### Request Body
- **url** (string) - Required - Full URL to the homepage of the store, including parameters for language selection.
- **email** (string) - Required - Email address of the store administrator.
- **parent_private_key** (string) - Optional - The private key obtained from the first registration, used to link multiple language keys.

### Request Example
curl -X POST "http://searchserverapi1.com/api/signup/json" -d 'url=http://example.com/?language=english&email=test@example.com'

### Response
#### Success Response (200)
- **api** (string) - Public API key
- **private** (string) - Private API key

#### Response Example
{"keys":{"api":"XXXXXXXXXX","private":"XXXXXXXXXXXXXXXXXXXX"}}
```

--------------------------------

### Search by attribute using queryBy

Source: https://docs.searchanise.io/search-api

Example of performing a search restricted to a specific product attribute.

```http
http://searchserverapi1.com/search?api_key=XXXXXXXXXXX&queryBy[title]=ipad
```

--------------------------------

### Apply the patch file

Source: https://docs.searchanise.io/cs-cart-4-12-1-full-re-indexation-stuck

Execute this command to apply the provided diff file to the store files.

```bash
patch -p1 < se-6180-adapt-storefront-languages.diff
```

--------------------------------

### Exact word matching example

Source: https://docs.searchanise.io/search-precision-settings

Demonstrates matching complete words only, excluding partial matches.

```text
shirt
```

--------------------------------

### Exclude Input Class

Source: https://docs.searchanise.io/modify-widgets-appearance

Example of adding the class to a search input to disable Searchanise functionality.

```html
<input class="snize-exclude-input" ..>
```
Tokens:
Raw