API Documentation
Intégrez SmartSell avec vos systèmes existants en utilisant notre API RESTful complète
Pour Commencer
Apprenez à vous authentifier et à effectuer votre première requête API
Authentification
L'API SmartSell utilise l'authentification par clé API. Incluez votre clé API dans l'en-tête Authorization de toutes les requêtes.
Remarque : Gardez votre clé API sécurisée et ne l'exposez jamais dans le code côté client.
URL de Base
Toutes les requêtes API doivent être faites à l'URL de base suivante :
https://api.smartsell.africa/v1/
Format de Réponse
Toutes les réponses sont renvoyées au format JSON avec la structure suivante :
Points d'Exécution de l'API
Liste complète des points d'accès disponibles organisés par type de ressource
Entreprises
| Méthode | Point d'Accès | Description |
|---|---|---|
| GET | /businesses | Lister toutes les entreprises |
| POST | /businesses | Créer une nouvelle entreprise |
| GET | /businesses/{id} | Obtenir les détails de l'entreprise |
| PUT | /businesses/{id} | Mettre à jour les informations de l'entreprise |
Produits
| Méthode | Point d'Accès | Description |
|---|---|---|
| GET | /businesses/{business_id}/products | Lister tous les produits |
| POST | /businesses/{business_id}/products | Créer un nouveau produit |
| GET | /products/{id} | Obtenir les détails du produit |
| PUT | /products/{id} | Mettre à jour les informations du produit |
| DELETE | /products/{id} | Supprimer un produit |
Ventes
| Méthode | Point d'Accès | Description |
|---|---|---|
| GET | /businesses/{business_id}/sales | Lister toutes les transactions de vente |
| POST | /businesses/{business_id}/sales | Créer une nouvelle vente |
| GET | /sales/{id} | Obtenir les détails de la vente |
| GET | /sales/{id}/receipt | Obtenir le reçu de la vente |
Exemples de Code
Exemples concrets pour vous aider à intégrer rapidement l'API SmartSell
Créer un Nouveau Produit
Créer un Nouveau Produit
};
Créer un Nouveau Produit
Créer un Nouveau Produit
Codes d'erreur
Comprendre les réponses d'erreur de l'API et comment les gérer
| Code | Statut | Description |
|---|---|---|
| 200 | OK | Requête réussie |
| 201 | Créé | Ressource créée avec succès |
| 400 | Mauvaise requête | Paramètres de requête non valides |
| 401 | Non autorisé | Clé API invalide ou manquante |
| 403 | Interdit | Permissions insuffisantes |
| 404 | Non trouvé | Ressource non trouvée |
| 429 | Limitation de taux | Trop de requêtes |
| 500 | Erreur serveur | Erreur interne du serveur |
Besoin de support API ?
Notre équipe de support développeur est là pour vous aider à intégrer avec succès l'API SmartSell.