Intégrations
Dictionnaire Guides Bientôt Nouveautés
Tarifs FAQ Mon Compte Contact
Documentation

Documentation API

API REST read-only pour intégrer vos données de veille tarifaire dans vos outils

Sommaire
1

Authentification

L'API utilise une clé API dédiée, distincte de votre session dashboard. Incluez-la dans le header Authorization de chaque requête :

Authorization: Bearer rvk_VOTRE_CLE_API

La clé se crée depuis Dashboard → Intégrations → MCP Rivalyse : elle est affichée en clair une seule fois à la création, jusqu'à 5 clés actives simultanément, et reste valable sans expiration tant qu'elle n'est pas révoquée. Elle est disponible sur tous les plans payants (non disponible en période d'essai).

La clé API ne doit jamais apparaître dans une URL (paramètre de requête) ni être partagée dans du code public.

Chaque requête est isolée par client_id : vous ne pouvez accéder qu'aux données de votre propre compte.

2

Rate limiting

L'API publique est limitée à 30 requêtes par minute par adresse IP (distinct du dashboard qui a sa propre limite de 60 req/min).

En cas de dépassement, l'API retourne 429 Too Many Requests. Attendez quelques secondes avant de réessayer.

3

Liste des prix courants

GET /api/public/prices Clé API 30/min

Retourne tous les prix courants de vos produits actifs.

Reponse

{ "count": 23, "data": [ { "url_id": 1, "sku": "MOT-HB-250", "product_name": "Moteur hors-bord 250cv", "tag": "Moteurs", "competitor_name": "ConcurrentA", "url_client": "https://votresite.fr/produit/...", "url_competitor": "https://concurrent.fr/produit/...", "price_client": 12500.00, "price_competitor": 11990.00, "diff": -510.00, "is_cheaper": 1, "stock": "En stock", "last_scraped_at": "2026-03-07T06:00:12Z" } ] }
4

Detail d'un produit + historique

GET /api/public/prices/:urlId Clé API 30/min

Retourne le prix courant d'une paire client/concurrent ainsi que l'historique des 90 derniers jours.

ParamètreTypeDescription
urlIdnumberID de la paire URL (visible dans la colonne # du dashboard)

Reponse

{ "current": { "url_id": 1, "sku": "MOT-HB-250", "product_name": "Moteur hors-bord 250cv", "price_client": 12500.00, "price_competitor": 11990.00, "diff": -510.00, "is_cheaper": 1, "stock": "En stock", "last_scraped_at": "2026-03-07T06:00:12Z" }, "history_count": 46, "history": [ { "scraped_at": "2026-03-07T06:00:12Z", "price_client": 12500.00, "price_competitor_old": 12200.00, "price_competitor_new": 11990.00, "price_diff": -210.00, "stock": "En stock" } ] }
5

Alertes recentes

GET /api/public/alerts Clé API 30/min

Retourne les alertes envoyées sur les N derniers jours (défaut 30, max 90).

ParamètreTypeDescription
daysquery (number)Nombre de jours a remonter (1-90, defaut 30)

Exemple

GET /api/public/alerts?days=7

Reponse

{ "days": 7, "count": 3, "data": [ { "id": 42, "alert_type": "competitor_cheaper", "sent_at": "2026-03-06T12:00:00Z", "sku": "MOT-HB-250", "product_name": "Moteur hors-bord 250cv", "competitor_name": "ConcurrentA", "url_client": "https://votresite.fr/...", "url_competitor": "https://concurrent.fr/..." } ] }
6

Export complet (JSON / CSV)

GET /api/public/export Clé API 30/min

Exporte toutes les données de prix courants en JSON ou CSV. Le CSV utilise le séparateur ; (compatible Excel FR) avec BOM UTF-8.

ParamètreTypeDescription
formatquery (string)json (defaut) ou csv

Exemples

GET /api/public/export?format=json GET /api/public/export?format=csv

Le JSON inclut un champ diff_pct (écart en pourcentage) en plus des champs standard.

7

Webhooks sortants

Configurez des webhooks depuis l'onglet Integrations du dashboard pour recevoir des notifications en temps reel sur vos systemes.

Events disponibles

EventDéclencheur
price.changedAu moins un prix concurrent a changé depuis le dernier relevé
competitor.cheaperLe concurrent est moins cher que vous et l'écart atteint ou dépasse votre seuil d'alerte
url.errorUne URL a été désactivée automatiquement après 10 échecs consécutifs

Ce payload générique s'applique aux webhooks generic (URL quelconque). Les webhooks Slack, Microsoft Teams et Discord reçoivent le format natif de chaque plateforme, pas cette structure JSON.

Payload envoye

Le webhook price.changed n'est déclenché que s'il y a au moins un changement de prix lors d'un run de scraping (jusqu'à 4 fois par jour), et regroupe tous les changements du client dans un tableau changes :

{ "event": "price.changed", "client_id": 42, "timestamp": "2026-03-07T06:00:12Z", "data": { "changes_count": 1, "changes": [ { "sku": "MOT-HB-250", "product_name": "Moteur hors-bord 250cv", "competitor_name": "ConcurrentA", "price_client": 12500.00, "price_competitor_old": 12200.00, "price_competitor_new": 11990.00, "diff": -510.00, "url_client": "https://boutique-client.fr/produit-x", "url_competitor": "https://concurrent-a.fr/produit-x" } ] } }

Retry et auto-désactivation

  • Jusqu'à 3 nouvelles tentatives après l'essai initial (4 essais au total), avec backoff quadratique (1s, 4s, 9s)
  • Timeout : 10 secondes par tentative
  • Apres 10 echecs consecutifs, le webhook est automatiquement desactive
  • Votre endpoint doit répondre avec un status 2xx pour confirmer la réception
8

Vérification de signature HMAC

Chaque requete webhook inclut un header X-Webhook-Signature contenant un HMAC-SHA256 du body, signe avec votre secret (affiche une seule fois a la creation).

Vérification en Node.js

const crypto = require('crypto'); function verifyWebhook(body, signature, secret) { const expected = crypto .createHmac('sha256', secret) .update(body) .digest('hex'); return crypto.timingSafeEqual( Buffer.from(signature, 'hex'), Buffer.from(expected, 'hex') ); } // Dans votre handler Express : app.post('/webhook', (req, res) => { const sig = req.headers['x-webhook-signature']; const raw = JSON.stringify(req.body); if (!verifyWebhook(raw, sig, process.env.WEBHOOK_SECRET)) { return res.status(401).send('Signature invalide'); } // Traiter l'event... res.sendStatus(200); });

Vérification en Python

import hmac, hashlib def verify_webhook(body: bytes, signature: str, secret: str) -> bool: expected = hmac.new( secret.encode(), body, hashlib.sha256 ).hexdigest() return hmac.compare_digest(signature, expected) # Flask exemple : @app.route('/webhook', methods=['POST']) def handle_webhook(): sig = request.headers.get('X-Webhook-Signature', '') if not verify_webhook(request.data, sig, WEBHOOK_SECRET): return 'Signature invalide', 401 # Traiter l'event... return '', 200
9

Codes d'erreur

CodeSignification
200Succes
400Paramètre invalide (urlId non numerique, etc.)
401Clé API manquante, invalide ou révoquée
404Ressource introuvable ou appartenant a un autre client
429Rate limit depasse (30 req/min)
500Erreur serveur interne

Toutes les erreurs retournent un JSON avec un champ error :

{ "error": "Cle API manquante, invalide ou revoquee" }
10

Exemples d'intégration

cURL

curl -H "Authorization: Bearer rvk_VOTRE_CLE_API" \ https://votre-domaine.fr/api/public/prices

JavaScript (fetch)

const res = await fetch('/api/public/prices', { headers: { 'Authorization': 'Bearer ' + apiKey } }); const { data } = await res.json(); console.log(data);

Python (requests)

import requests r = requests.get( 'https://votre-domaine.fr/api/public/prices', headers={'Authorization': f'Bearer {api_key}'} ) data = r.json()['data']

Google Sheets (Apps Script)

function importPrices() { var apiKey = PropertiesService.getScriptProperties() .getProperty('API_KEY'); var res = UrlFetchApp.fetch( 'https://votre-domaine.fr/api/public/export?format=json', { headers: { 'Authorization': 'Bearer ' + apiKey } } ); var data = JSON.parse(res.getContentText()).data; // Ecrire dans la feuille... }

Power BI / Excel (Power Query M)

let Source = Json.Document( Web.Contents( "https://votre-domaine.fr/api/public/export", [Headers=[Authorization="Bearer rvk_VOTRE_CLE_API"]] ) ), Data = Source[data] in Table.FromRecords(Data)
11

MCP (agents IA)

En plus de l'API REST ci-dessus, Rivalyse expose un serveur MCP (Model Context Protocol) en lecture seule, permettant à un assistant IA (Claude, ChatGPT, Cursor) d'interroger votre veille tarifaire en langage naturel. Présentation complète et snippets d'installation par outil : page MCP Rivalyse.

Endpoint https://mcp.rivalyse.com/mcp

Authentification identique à l'API REST : header Authorization: Bearer rvk_VOTRE_CLE_API (voir § Authentification). Le MCP est strictement en lecture seule : aucun des outils ci-dessous ne peut modifier vos données.

Outils disponibles

OutilRôlePlan requis
Situer un produitRetrouve un produit surveillé et son état actuelPro, Business+
Chercher des produitsRecherche dans le catalogue surveillé par mot-cléPro, Business+
Détailler un prixHistorique et détail des prix concurrents d'un produitPro, Business+
Résumé compétitifBilan mensuel : produits moins chers, plus chers, à égalitéPro, Business+
Lister les alertesAlertes récentes (changement de prix, rupture, erreur)Pro, Business+
Vérifier le monitoringÉtat de santé de la surveillance (URLs en erreur, couverture)Pro, Business+
Recommandations de repricingSuggestions d'ajustement de prix basées sur la concurrenceBusiness+

Limites

60 appels par minute et 1000 appels par heure par clé API (garde-fou unique, sans quota différencié par plan). Au-delà, l'agent reçoit un message d'erreur applicatif indiquant l'heure de réinitialisation, sans code HTTP non-200.

Intégrations disponibles

Connectez vos outils. Cliquez sur une integration pour accéder à sa documentation complète.

No-code

Les badges Pro et Business+ indiquent le plan minimum requis. Sans badge = disponible dès le plan Basic.

↑ Retour en haut