Aller au contenu principal

Introduction

Bienvenue dans la documentation de l'API publique Events‑ERP. Elle décrit comment intégrer catalogue, réservations et notifications dans vos applications.

À propos

L'API REST Events‑ERP permet d'intégrer les fonctionnalités de vente et de réservation directement dans vos sites et applications, tout en conservant la gestion des paiements et de la comptabilité côté plateforme.

Débutons avec l'authentification.

Authentification

Les requêtes sur les endpoints publics du catalogue ne nécessitent pas de clé. En revanche, la création et le suivi des réservations exigent une clé API rattachée à votre entreprise (pas à un utilisateur individuel).

Obtenir votre clé API

Connectez-vous au dashboard Gérant, puis ouvrez API développeur. Cliquez sur Générer pour créer une clé nommée (ex. « Site vitrine externe »).

Note : La clé complète (préfixe erp_) n'est affichée qu'une seule fois. Copiez-la et stockez-la dans un gestionnaire de secrets (variables d'environnement côté serveur de préférence).

Les scopes par défaut sont read:public,write:bookings : lecture du catalogue authentifiée et création de réservations.

Utilisation

Incluez votre clé dans le header Authorization de chaque requête protégée :

Authorization: Bearer erp_VOTRE_CLE_API

Vous pouvez aussi envoyer la clé via le header X-Api-Key (équivalent).

URL de base

L'URL de base de l'API est la suivante :

http://45.10.154.145:3030

En développement local : http://localhost:3000

Format des données

L'API utilise le format JSONpour les corps de requête et les réponses. Les dates d'événement sont au format ISO 8601 (ex. 2026-08-01T10:00:00.000Z).

Tarification

Events‑ERP prélève une commission de 5 %sur les ventes encaissées via la plateforme (vitrine Events‑ERP, widget ou paniers créés via l'API). Vous conservez l'essentiel de vos revenus ; il n'y a pas d'abonnement mensuel obligatoire pour utiliser la vitrine et l'API.

Limites & sécurité

  • Rate limiting sur les routes publiques (réponse 429 si dépassement)
  • Origines CORS : liste de domaines autorisés dans API développeur
  • Révocation immédiate des clés compromises depuis le dashboard
  • Journalisation des accès API (audit)