VueJs component for Akkurate for search

Important

Pour utiliser ce composant, vous devez avoir un compte sur Akkurate4search et donc avoir une clé d'API. Le domaine sur lequel vous utilisez ce composant doit être autorisé dans la configuration de votre compte.

Installation

Pour installer le composant, utilisez npm. Exécutez la commande suivante :

npm i akk4search_vuejs --save

Usage

Importez le composant dans la section "script" de votre code

import Akk4search from '@/akk4search.vue';
export default Vue.extend({
    ...
    components: {
        Akk4search
    }
    ...
});

Appelez le composant dans la section "template" de votre code

<template>
    <!-- Classic example -->
    <akk4search api-key="your_api_key" environment="your_environment"  />
    
    <!-- With link patterns -->
    <akk4search api-key="your_api_key" environment="your_environment" :patterns="your_pattern_object"  />
</template>

Environment

Ce paramètre est utilisé pour définir l'environnement sur lequel vous utilisez le composant. Voici les 3 valeurs possibles :

BACK
FRONT
MIDDLE

Si vous definissez la valeur à BACK, l'API ne retournera que les résultats contenants BACK dans leur champ "environment". Concernant les contenus de type "liens", ils doivent posséder au moins un lien de type BACK pour remonter dans les résultats.

Ce paramètre est aussi retourné dans le header "Environment" de vos requêtes. Pensez donc à l'autoriser sur votre serveur si vous utilisez PHP SDK for Akkurate For Search car il vous sera demandé par la suite.

Masquer les suggestions

Vous avez la possibilité de masquer les suggestions et de n'afficher que les résultats en passant le paramètre ":suggests" sur "false". Par défaut, "suggests" est à "true"

<akk4search api-key="..." environment="..." :suggests="false"  />

Ce paramètre est aussi retourné dans le header "Environment" de vos requêtes. Pensez donc à l'autoriser sur votre serveur si vous utilisez PHP SDK for Akkurate For Search car il vous sera demandé par la suite.

Patterns

Ce paramètre vous permet de définir des variables personnalisées. Celles-ci doivent matcher avec les variables de vos liens.

Par exemple : vous avez enregistré le lien de contenu suivant :

https://www.npmjs.com/package/{packageId}

Pour que les variables soient converties, vous devez passer l'objet de référence dans le paramètre :patterns, comme ceci :

<akk4search api-key="..." environment="..." :patterns="{packageId : 'akk4search_vuejs'}"  />

Votre lien deviendra :

https://www.npmjs.com/package/akk4search_vuejs

Urls

Ce paramètre vous permet de définir des urls de requêtes et de soumissions personnalisées. Si elles sont renseignées, le composant les utilisera pour effectuer les recherches et/ou soumettre les formulaires. Vous pouvez renseigner 4 types d'url :

all : pour la recherche de contenu par mots-clés
entity : pour la recherche de contenu par entité
submit : pour soumettre le formulaire et être redirigé sur page de votre serveur
results : pour être redirigé sur page de votre serveur vous permettant d'afficher tous les résultats liés à une entité

Vous pouvez structurer les urls comme bon vous semble. Il faut par contre, fournir obligatoirement les chaines

{%searchword%} pour les urls de type "all" & "submit"
{%entity_uuid%} pour les urls de type "entity" & "results"

Elles seront remplacées dynamiquement par les valeurs recherchées dans le formulaire. A vous ensuite d'effectuer le traitement sur votre serveur en récupérant les paramètres d'urls.

Voici un exemple d'utilisation :

<akk4search
    api-key="..."
    environment="..."
    :patterns="..."
    :urls="{
        all : 'https://YOUR_URL/api/v1/search/{%searchword%}',
        entity : 'https://YOUR_URL/api/v1/entity/{%entity_uuid%}',
        submit : 'https://YOUR_URL/search/{%searchword%}',
        results : 'https://YOUR_URL/results/{%entity_uuid%}'
    }"
    />

Une fois les données reçues sur votre serveur, vous pouvez par exemple, utiliser PHP SDK for Akkurate For Search pour effectuer votre recherche en fournissant les paramètres reçu.