Documentation

API Board+

⚠️ Fonctionnalité en développement

L'API REST de Board+ est actuellement en développement et n'est pas encore disponible.

Cette page documente l'API telle qu'elle sera implémentée dans une version future. Les endpoints, formats de requêtes et réponses décrits ci-dessous sont sujets à modifications.

Prévu : Q2 2026 Voir la roadmap complète

L'API REST de Board+ permettra d'intégrer vos applications externes avec le système de gestion. Tous les endpoints seront sécurisés et utiliseront l'authentification par token.

Statut actuel du développement

✅ Complété

  • Spécifications techniques
  • Architecture de l'API
  • Documentation préliminaire

🚧 En cours

  • Implémentation des endpoints
  • Système d'authentification
  • Tests automatisés
  • Documentation OpenAPI

Solutions actuelles disponibles

En attendant la disponibilité de l'API REST, vous pouvez utiliser les alternatives suivantes :

Export/Import de données

Utilisez les fonctionnalités d'export (CSV, Excel, PDF) et d'import disponibles dans chaque module pour échanger des données avec d'autres systèmes.

Accès direct à la base de données

Pour les intégrations avancées, vous pouvez accéder directement à la base de données (avec précaution). Consultez la documentation des migrations pour la structure des tables.

Notifications par email

Configurez les notifications par email pour être informé des événements importants (nouvelles commandes, stock bas, etc.).

Documentation Préliminaire (Sujet à modifications)

La documentation ci-dessous représente notre vision de l'API. Les détails peuvent changer lors de l'implémentation.

Authentification (Planifiée)

NON DISPONIBLE 
POST /api/v1/auth/login
Content-Type: application/json

{
  "email": "admin@example.com",
  "password": "motdepasse"
}

Endpoints Planifiés

Produits

  • GET /api/v1/products
  • POST /api/v1/products
  • PUT /api/v1/products/{id}
  • DELETE /api/v1/products/{id}
Non disponible

Clients

  • GET /api/v1/clients
  • POST /api/v1/clients
  • PUT /api/v1/clients/{id}
  • DELETE /api/v1/clients/{id}
Non disponible

Commandes

  • GET /api/v1/orders
  • POST /api/v1/orders
  • PATCH /api/v1/orders/{id}/status
Non disponible

Factures

  • GET /api/v1/invoices
  • POST /api/v1/invoices
  • PATCH /api/v1/invoices/{id}/paid
Non disponible

Point de Vente

  • POST /api/v1/pos/sale
  • GET /api/v1/pos/receipt/{id}
Non disponible

Rapports

  • GET /api/v1/reports/sales
  • GET /api/v1/reports/stock
Non disponible

Webhooks (Planifiés)

Le système de webhooks n'est pas encore implémenté.

Les webhooks permettront de recevoir des notifications en temps réel sur les événements importants :

order.created
order.updated
invoice.paid
product.stock.low
product.stock.out
pos.sale.completed

Restez informé du développement

Vous souhaitez être notifié dès que l'API sera disponible ?

Recevoir une notification Voir la roadmap complète

Questions sur l'API ?

Vous avez des questions sur l'API ou des besoins spécifiques d'intégration ?

Contactez-nous : support@boardplus.bf