Documentation API
L'API Avisly vous permet d'intégrer les avis clients dans vos applications. Utilisez nos endpoints REST pour récupérer les avis, les statistiques et bien plus encore.
URL de base
https://avisly.fr/apiAuthentification
La plupart des endpoints nécessitent une authentification. Vous devez être connecté et inclure votre token d'authentification dans les en-têtes de vos requêtes.
Header:
Authorization: Bearer YOUR_TOKENEndpoints disponibles
Workspaces
/api/workspacesListe tous les workspaces de l'utilisateur authentifié
/api/workspacesCrée un nouveau workspace
Avis
/api/reviewsCrée un nouvel avis pour un workspace
Utilisation
/api/usageRécupère les statistiques d'utilisation de l'utilisateur
Exemple d'utilisation
JavaScript (fetch)
fetch('https://avisly.fr/api/workspaces', {
headers: {
'Authorization': 'Bearer YOUR_TOKEN',
'Content-Type': 'application/json'
}
})
.then(response => response.json())
.then(data => console.log(data));cURL
curl -X GET https://avisly.fr/api/workspaces \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json"API Publique
Les endpoints publics permettent d'accéder aux avis et statistiques via une clé API. La clé API est obligatoire pour garantir l'accès privé aux workspaces.
/api/public/workspaces/[slug]/reviewsRécupère les avis approuvés d'un workspace
Paramètres de requête :
limit(1-100, défaut: 20) - Nombre d'avis à retourneroffset(défaut: 0) - Décalage pour la paginationmin_rating(1-5, défaut: 1) - Note minimalesort(newest|oldest|rating_desc|rating_asc, défaut: newest) - Triapi_key(obligatoire) - Clé API pour accéder aux données
Exemple :
GET /api/public/workspaces/mon-workspace/reviews?limit=10&min_rating=4&api_key=VOTRE_CLE/api/public/workspaces/[slug]/statsRécupère les statistiques publiques (note moyenne, nombre d'avis, distribution)
Exemple :
GET /api/public/workspaces/mon-workspace/stats?api_key=VOTRE_CLEAuthentification API : Incluez votre clé API dans l'en-tête X-API-Key ou comme paramètre api_key.