Commencer

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/api

Authentification

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_TOKEN

Endpoints disponibles

Workspaces

GET/api/workspaces

Liste tous les workspaces de l'utilisateur authentifié

POST/api/workspaces

Crée un nouveau workspace

Avis

POST/api/reviews

Crée un nouvel avis pour un workspace

Utilisation

GET/api/usage

Ré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 sans authentification. Une clé API optionnelle augmente la limite de requêtes de 100 à 1000 par heure.

GET/api/public/workspaces/[slug]/reviews

Récupère les avis approuvés d'un workspace

Paramètres de requête :

  • limit (1-100, défaut: 20) - Nombre d'avis à retourner
  • offset (défaut: 0) - Décalage pour la pagination
  • min_rating (1-5, défaut: 1) - Note minimale
  • sort (newest|oldest|rating_desc|rating_asc, défaut: newest) - Tri
  • api_key (optionnel) - Clé API pour augmenter la limite

Exemple :

GET /api/public/workspaces/mon-workspace/reviews?limit=10&min_rating=4
GET/api/public/workspaces/[slug]/stats

Récupère les statistiques publiques (note moyenne, nombre d'avis, distribution)

Exemple :

GET /api/public/workspaces/mon-workspace/stats

Authentification API : Incluez votre clé API dans l'en-tête X-API-Key ou comme paramètre api_key.

Retour à l'accueil