Vous pouvez utiliser l’API de Securating pour envoyer des invitations à vos clients afin qu’ils vous donnent leur avis sur vos produits et/ou services.
Pour cela rien de plus simple.
Avec Securating les avis sont récoltés directement sur votre site Internet à l’aide d’une Url encodée.
Pour envoyer l’email d’invitation, automatiquement via notre serveur, utilisez l’API suivante:
https://api.securating.io/invitation/create
Ces deux API utilisent les mêmes paramètres, qui doivent être envoyés à l’aide d’une requête HTTP POST.
PARAMETRES | DESCRIPTIONS |
keywebsite | La clé de vérification de votre site internet. |
L’email de votre client. | |
first_name | Le prénom de votre client. |
last_name | Le Nom de votre client. |
company_name | Le nom de votre entreprise ou service. |
product | Le code produit concernant votre avis. Si la référence n’existe pas elle est créé à la volée. |
product_ean | Code EAN utilisé lors pour la mise à jour du produit. |
product_desc | Description commerciale utilisé pour la mise à jour du produit. |
survey_only | Paramètre de type booléen (0: faux / 1:vraie) qui indique si la sollicitation concerne uniquement un sondage par thématiques. |
force_invitation | L’API ne permet pas la création d’invitations successives trop rapprochées dans le temps ( < 24 heures) pour un même email. En positionnant ce paramètre avec une valeur quelconque, l’API vous permettra de passer outre cette vérification. Il est conseillé de ne positionner ce paramètre que dans des phase de tests. |
thematics | Les codes thématiques concernant votre avis. Vous pouvez renseigner aux maximum trois codes séparées par une virgule (Voir la liste de code) . |
url | L’url vers sur laquelle vous souhaitez récolter l’avis. |
days | Le nombre de jour d’attente avant d’envoyer l’invitation par mail à votre client. Par default un délais de 6 jours est appliqué. |
recall_count | Nombre de relance à effectuer, tant que le client n’a pas donner son avis, la valeur par défaut est de 3 relances. |
profile_id | Identifiant du modérateur à l’origine de la demande de sollicitation. Ces identifiants doivent préalablement créés depuis votre manager. Ce paramètre est optionnel. |
webhook | Url d’alerte informant des changements d’état de la sollicitation. Par exemple si l’url indiqué est « https://ws.monsite.com/securating?id=123456 ». Nos robots contacteront votre url en ajoutant un paramètre step. step=invitation-created: lors de la réception de la demande step=mail-send: lors de l’envoi du mail d’invitation step=mail-recall: lors de l’envoi d’une relance. step=link-opened: lorsque votre client a affiché le formulaire de sais d’avis. step=review-saved: lorsque votre client aura enregistré son avis. A l’étape « review-saved« , des paramètres supplémentaires sont ajoutés: – « rating » indique la note donnée avec l’avis. – « comment » contient le commentaire associé à l’avis (codé en base64) Nos robots attendent un retour contenant « ok » ou « success ». |
customer_gender | La civilité de votre client (dans le cadre d’un avis professionnel B2B). |
customer_bio | Le poste occupé de votre client (dans le cadre d’un avis professionnel B2B). |
customer_link | L’url du site web de votre client (dans le cadre d’un avis professionnel B2B). |
customer_avatar | L’url du logo de votre client (dans le cadre d’un avis professionnel B2B). |
meta_<keys> | Informations retournées via les web_hook sans traitement particulier. |
hashtag | Le hashtag a associer à l’Avis lors de sa création |
with_gift | Paramètre de type booléen (0: faux / 1:vraie) qui indique si une contrepartie est donnée en échange de l’Avis. |
gift_description | Description du type de contrepartie à associer à l’Avis |
from_order | Paramètre de type booléen (0: faux / 1:vraie) qui indique si l’Avis fait suite à une commande. |
order_<fields> | Informations associées au produit ou au service commandé. order_date: La date de la commande order_number: Le numéro de la commande order_item_type: le type d’item [product/service] de commande order_item_code: Le code de l’item order_item_desc: La description de l’item order_service_start: La date de début du service order_service_end: La date de fin du service |
L’exemple ci-dessous vous montre une utilisation en language PHP.
<?
function httpPost($url, $data){
$options = array(
'http' => array(
'header' => "Content-type: application/x-www-form-urlencoded\r\n",
'method' => 'POST',
'content' => http_build_query($data)
)
);
$context = stream_context_create($options);
return file_get_contents($url, false, $context);
}
$api = 'https://api.securating.io/invitation/create';
$returnedLink = httpPost(
$api,
array(
'keywebsite' => 'ma-cle-de-verification',
'email' => 'mon-email-ici',
'first_name' => 'prenom-de-mon-client-ici',
'last_name' => 'nom-de-mon-client-ici',
'company_name' => 'mon-entreprise-ici',
'days' => '0',
'product' => '25:0001',
'thematics' => '1000100,1000200,1000400',
'url' => 'https://mon-site-web/ma-page-web'
)
);
echo 'link: <a href="'.$returnedLink.'">Click on me</a>';
?>
Votre clé de vérification est disponible en téléchargement depuis la rubrique site de votre manager. C’est la même clé utilisée pour la vérification de votre site.
Tester l’API en recevant une invitation à déposer un avis sur Securating.com