Avis

Les avis permettent aux clients de noter et commenter des produits, agents ou rendez-vous. Les avis supportent plusieurs types : STORE_PRODUCT, MULTI_SERVICE_AGENT, MULTI_SERVICE_APPOINTMENT.

SDK : client.review

Endpoints

Soumettre un avis (client)

Permet à un client de soumettre un nouvel avis.


POST /app/{appId}/review/submit

Requête

Champ	Type	Requis	Description
`appApiKey`	string	Oui	Clé API de l’application
`customerApiKey`	string	Oui	Clé API du client (téléphone)
`type`	string	Oui	`STORE_PRODUCT`, `MULTI_SERVICE_AGENT`, `MULTI_SERVICE_APPOINTMENT`
`rating`	number	Oui	Note (1-5)
`title`	string	Non	Titre de l’avis
`comment`	string	Non	Commentaire
`images`	string[]	Non	URLs des images
`productId`	string	Non	ID du produit (si type STORE_PRODUCT)
`agentId`	string	Non	ID de l’agent (si type MULTI_SERVICE_AGENT)
`appointmentId`	string	Non	ID du rendez-vous (si type MULTI_SERVICE_APPOINTMENT)


curl -X POST https://api.applite.ai/app/{appId}/review/submit \
  -H "Content-Type: application/json" \
  -d '{
    "appApiKey": "app_api_key",
    "customerApiKey": "+2250700000000",
    "type": "STORE_PRODUCT",
    "rating": 4,
    "title": "Très bon produit",
    "comment": "Qualité excellente",
    "productId": "product_id"
  }'

Réponse


{
  "success": true,
  "data": {
    "id": "review_id",
    "appId": "app_id",
    "customerId": "customer_id",
    "type": "STORE_PRODUCT",
    "rating": 4,
    "title": "Très bon produit",
    "comment": "Qualité excellente",
    "images": [],
    "isVerified": false,
    "productId": "product_id",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Erreurs

Code	Description
`Invalid app`	Application non trouvée
`Customer not found`	Client non trouvé
`Review already exists`	Un avis existe déjà pour cet élément

Lister les avis publics

Liste les avis vérifiés (endpoint public).


POST /app/{appId}/review/public

Requête

Champ	Type	Requis	Description
`appApiKey`	string	Non	Clé API de l’application
`customerApiKey`	string	Non	Clé API du client
`type`	string	Non	Filtrer par type
`productId`	string	Non	Filtrer par produit
`agentId`	string	Non	Filtrer par agent
`appointmentId`	string	Non	Filtrer par rendez-vous
`page`	number	Non	Numéro de page
`limit`	number	Non	Éléments par page


curl -X POST https://api.applite.ai/app/{appId}/review/public \
  -H "Content-Type: application/json" \
  -d '{
    "appApiKey": "app_api_key",
    "type": "STORE_PRODUCT",
    "productId": "product_id",
    "limit": 10
  }'

Obtenir un avis

Récupère les détails d’un avis par son ID.


POST /app/{appId}/review/{id}

Requête

Champ	Type	Requis	Description
`apiKey`	string	Oui	Clé API de l’utilisateur


curl -X POST https://api.applite.ai/app/{appId}/review/{id} \
  -H "Content-Type: application/json" \
  -d '{ "apiKey": "user_api_key" }'