API REST Akwabax

Intégrez facilement nos solutions POS avec vos systèmes existants via notre API REST moderne et sécurisée.

Version 1.0 REST/JSON HTTPS Only

Base URL

https://akwabax.com/api/v1

Authentification

POST /api/auth

Obtenir un token d'accès pour les requêtes sécurisées.

Request Body:

{
  "api_key": "YOUR_API_KEY",
  "api_secret": "YOUR_SECRET_KEY"
}

Response:

{
  "success": true,
  "token": "eyJ0eXAiOiJKV1QiLCJhbGc...",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Endpoints Principaux

POST /sales

Créer une nouvelle vente dans le système POS.

Request Body:

{
  "store_id": "STR-001",
  "items": [
    {
      "product_id": "PROD-001",
      "quantity": 2,
      "price": 500
    }
  ],
  "payment_method": "mobile_money",
  "customer_phone": "0708305030",
  "total": 1000
}

GET /inventory

Récupérer l'inventaire actuel d'un magasin.

Query Parameters:

store_id string ID du magasin

POST /payment/mobile

Traiter un paiement Mobile Money (Orange Money, MTN, Wave).

Request Body:

{
  "amount": 5000,
  "phone": "0708305030",
  "provider": "orange_money",
  "reference": "SALE-ABC123"
}

GET /reports/sales

Obtenir les rapports de ventes détaillés.

Query Parameters:

store_id string ID du magasin
start_date date Date de début (YYYY-MM-DD)
end_date date Date de fin (YYYY-MM-DD)

Webhooks

Recevez des notifications en temps réel pour les événements importants.

Événements Disponibles

  • sale.completed - Une vente a été complétée
  • payment.received - Un paiement a été reçu
  • inventory.low - Stock faible détecté
  • sync.completed - Synchronisation terminée

Codes de Statut HTTP

Code Signification
200 Requête réussie
201 Ressource créée avec succès
400 Requête invalide
401 Non autorisé
404 Ressource non trouvée
500 Erreur serveur interne

SDKs & Libraries

JavaScript

SDK pour Node.js et navigateurs

npm install @akwabax/sdk

PHP

Library pour applications PHP

composer require akwabax/sdk

Python

SDK pour applications Python

pip install akwabax-sdk

Limites de Taux

Plan Gratuit 100 requêtes/minute
Plan Pro 1000 requêtes/minute
Plan Enterprise Illimité

Besoin d'Aide?

Notre équipe technique est là pour vous accompagner dans l'intégration

Contact API Support Demander une Démo